mirror of
https://github.com/IT4Change/boilerplate-frontend.git
synced 2025-12-13 07:35:53 +00:00
documentation for npm run update
This commit is contained in:
parent
ff3e51efd9
commit
56f9c7d78b
16
README.md
16
README.md
@ -58,6 +58,8 @@ The following commands are available:
|
|||||||
| `npm run docs:build` | Build static documentation |
|
| `npm run docs:build` | Build static documentation |
|
||||||
| **Chromatic** | |
|
| **Chromatic** | |
|
||||||
| `npm run chromatic` | Run Chromatic. See Chromatic section for details |
|
| `npm run chromatic` | Run Chromatic. See Chromatic section for details |
|
||||||
|
| **Maintenance** | |
|
||||||
|
| `npm run update` | Check for updates |
|
||||||
|
|
||||||
### Docker
|
### Docker
|
||||||
|
|
||||||
@ -85,6 +87,17 @@ or you have to append it via parameter:
|
|||||||
npm run chromatic -- --project-token=...
|
npm run chromatic -- --project-token=...
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### Update
|
||||||
|
|
||||||
|
You can get a list of packes to update by running `npm run update`.
|
||||||
|
|
||||||
|
Appending `-u ` will also update the packages in the `package.json`. You have to run `npm install` again after.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm run update -- -u
|
||||||
|
npm install
|
||||||
|
```
|
||||||
|
|
||||||
## Endpoints
|
## Endpoints
|
||||||
|
|
||||||
The following endpoints are provided given the right command is executed or all three if `docker compose` is used:
|
The following endpoints are provided given the right command is executed or all three if `docker compose` is used:
|
||||||
@ -97,12 +110,13 @@ The following endpoints are provided given the right command is executed or all
|
|||||||
|
|
||||||
## TODO
|
## TODO
|
||||||
|
|
||||||
|
- [ ] translations & language switch
|
||||||
- [ ] tests
|
- [ ] tests
|
||||||
- [ ] stories
|
- [ ] stories
|
||||||
|
|
||||||
## Known Problems
|
## Known Problems
|
||||||
|
|
||||||
Currently none
|
- [ ] Image Rerender flicker
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user