habitica/website/client
negue 97a1d0f474 Storybook Example (#11494)
* 🎉 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
2019-12-05 22:35:23 +01:00
..
config/storybook Storybook Example (#11494) 2019-12-05 22:35:23 +01:00
public move static files & fixes 2019-10-15 18:45:20 +02:00
scripts Storybook Example (#11494) 2019-12-05 22:35:23 +01:00
src Storybook Example (#11494) 2019-12-05 22:35:23 +01:00
tests/unit Refactoring & Fix: editing group and challenges from user dashboard (#11418) 2019-11-16 18:36:27 +01:00
.browserslistrc old client structure 2019-10-01 11:44:38 +02:00
.eslintrc.js Storybook Example (#11494) 2019-12-05 22:35:23 +01:00
babel.config.js misc, fix client tests 2019-10-15 15:32:53 +02:00
package-lock.json Storybook Example (#11494) 2019-12-05 22:35:23 +01:00
package.json Storybook Example (#11494) 2019-12-05 22:35:23 +01:00
postcss.config.js misc, fix client tests 2019-10-15 15:32:53 +02:00
README.md Storybook Example (#11494) 2019-12-05 22:35:23 +01:00
vue.config.js fix svg path 2019-10-15 18:49:15 +02:00

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

See Configuration Reference.

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