From 4e75275a96430c55aeeea926602d387c2703d51d Mon Sep 17 00:00:00 2001 From: Ulf Gebhardt Date: Fri, 10 Nov 2023 18:30:30 +0100 Subject: [PATCH] update readme --- README.md | 40 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) diff --git a/README.md b/README.md index f6e8f01..01e4fc2 100644 --- a/README.md +++ b/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