mirror of
https://github.com/IT4Change/boilerplate-frontend.git
synced 2025-12-13 07:35:53 +00:00
update readme
This commit is contained in:
parent
b27f5e38e8
commit
4e75275a96
40
README.md
40
README.md
@ -10,6 +10,46 @@ To be able to build this project you need:
|
||||
- nodejs
|
||||
- npm
|
||||
|
||||
## Commands
|
||||
|
||||
The following commands are available:
|
||||
|
||||
| Command | Description |
|
||||
|-------------------------|------------------------------------------|
|
||||
| `npm install` | Project setup |
|
||||
| `npm run build` | Compiles and minifies for production |
|
||||
| **Develop** | |
|
||||
| `npm run dev` | Compiles and hot-reloads for development |
|
||||
| `npm run preview` | Run production preview |
|
||||
| **Test** | |
|
||||
| `npm run lint` | Runs all linters |
|
||||
| `npm test` | Run all tests & linters |
|
||||
| **Storybook** | |
|
||||
| `npm run storybook` | Run Storybook |
|
||||
| npm run build:storybook | Build static storybook |
|
||||
|
||||
## Technologie
|
||||
|
||||
- [X] ~~nuxt3~~
|
||||
- [x] vuetify
|
||||
- [x] vue3
|
||||
- [x] pinia store
|
||||
- [x] storybook
|
||||
- [-] eslint
|
||||
- [ ] vite vue3 ssr
|
||||
- [ ] figma
|
||||
- [ ] chromatic
|
||||
- [ ] jest
|
||||
- [ ] localization?
|
||||
- [ ] documentation?
|
||||
|
||||
## Known Problems
|
||||
|
||||
Storybook delivers Introduction producing errors: https://github.com/storybookjs/storybook/issues/24792
|
||||
|
||||
## Links
|
||||
|
||||
See [Configuration Reference](https://vitejs.dev/config/).
|
||||
|
||||
## License
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user