https://github.com/solidos/profile-pane
SolidOS pane that displays a personal profile page
https://github.com/solidos/profile-pane
running-code typescript webpack
Last synced: 2 months ago
JSON representation
SolidOS pane that displays a personal profile page
- Host: GitHub
- URL: https://github.com/solidos/profile-pane
- Owner: SolidOS
- Created: 2021-01-20T18:24:58.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-02-04T20:41:34.000Z (5 months ago)
- Last Synced: 2025-04-06T11:11:16.311Z (3 months ago)
- Topics: running-code, typescript, webpack
- Language: TypeScript
- Homepage:
- Size: 7.1 MB
- Stars: 7
- Watchers: 8
- Forks: 6
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# profile-pane
SolidOS pane that displays a personal profile page
This is a re-write that is going to replace the current profile pane
## Contribute
### Tech stack
- Typescript
- lit-html
- Jest
- Eslint
- SolidOS
### Tests
To run all tests:
```shell script
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:
```shell script
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.