habitica/website/client

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

Vue Structure

Currently pages and components are mixed in /src/components this is not a good way to find the files easy.

Thats why each changed / upcoming page / component should be put in either /src/components or in the /src/pages directory.

Inside Pages, each page can have a subfolder which contains sub-components only needed for that page - otherwise it has to be added to the normal components folder.

At the end of all the changes - the components should only contain components needed between all pages