mirror of
https://github.com/HabitRPG/habitica.git
synced 2025-12-19 15:48:04 +01:00
* 🎉 Working example of storybook and vue
* remove the older storybook version
* build storybook after client was built
* move storybook:build to npm-postintall
* remove automatically created eslint-disables + fix comment
* add back needed eslint :P + add @storybook/vue as devDep
* fix packagelock
* fix lint
* auto fixed lints + ignore dist/ node_modules/
* update package-lock.json
* add postbuild and readme
* add back customize config
* fix readme
* fix links in readme
* revert postbuild command
1.3 KiB
1.3 KiB
Habitica Client
Project setup
npm install
Compiles and hot-reloads for development
npm run serve
Compiles and minifies for production
npm run build
Run your unit tests
npm run test:unit
Lints and fixes files
npm run lint
Customize configuration
Storybook
Storybook is mainly used while working on UI-Components to see changes faster instead of using the website.
Start Storybook
npm run storybook:serve
This will start the storybook process, every *.stories.js-File is searched and added to the storybook overview.
Storybook Worklow
Usually when you working on component-name.vue you also create a component-name.stories.js file.
Example of the stories structure - Storybook Docs - CountBadge
Each function or example of this component will be put after storiesOf('Your Component', module),
in a separate .add('function of component', ...
Storybook Build
After each client build, storybook build is also triggered and will be available in dist/storybook