Skip to content

Latest commit

 

History

History
67 lines (43 loc) · 1.48 KB

README.md

File metadata and controls

67 lines (43 loc) · 1.48 KB
Raw

profile-pane

SolidOS pane that displays a personal profile page

This is a re-write that is going to replace the current profile pane

CI

Contribute

Tech stack

  • Typescript
  • lit-html
  • Jest
  • Eslint
  • SolidOS

Tests

To run all tests:

npm test

If you are a first time developer/user on Windows 10, the repository may give package issues regarding webpack or jest. If this is the case, simply run "npm audit fix" and upgrade the repository. It should work fine.

Unit tests

Unit tests use jest and are placed next to the tested file as *.spec.ts files.

Integration tests

Integration tests verify the rendering of the whole pane (with mocked HTTP requests) and are placed under ./src/integration-tests.

Dev Server

Start a webpack dev server:

npm start

Visit http://localhost:8080/ to render the pane. Adjust const webIdToShow in ./dev/index.ts to show a different profile.

Build

npm run build

The build is done by tsc, webpack is only used as dev server and not for production build.

Check before committing

npm run check

This does lint, build and test.

Notes

If suddenly many tests fail, it may be that the installation has ended up with two different instances of solid-logic. Run npm list solid-logic and make sure there is only one. Otherwise rm -rf node_modules package-lock.json && npm install should fix it.