@drinksandco/celler

Celler

Celler is the UI Library from Drinks & Co.

About Celler

• Built on top of @vue/cli.
• Uses Storybook to develop, showcase, and test each component.
• Unit testing based on Jest and Vue Testing Library.

Installation

Clone the repo and install node dependencies:

# install repo
$ npm install

Useful commands

# run storybook
$ npm start

# run unit tests
$ npm test

# run unit tests with watch mode enabled
$ npm run test:watch

Deploy to Github pages

To deploy current branch to github pages: https://uvinum.github.io/celler

npm run deploy

Creating a new version with Semantic Release

This repo features Semantic Release. This means that a new version will be automatically created when we merge to master. In order for this to happen, the commit message must be specific:

Tag: Short description (fixes #1234)

Note that the commit message MUST have the tag, so if it's a merge you must edit the commit title to include it. Just the description is not enough.

And pick your "Tag" from the following list:

• Fix - for a bug fix.
• Update - either for a backwards-compatible enhancement or for a rule change that adds reported problems.
• New - implemented a new feature.
• Breaking - for a backwards-incompatible enhancement or feature.
• Docs - changes to documentation only.
• Build - changes to build process only.
• Upgrade - for a dependency upgrade.
• Chore - for refactoring, adding tests, etc. (anything that isn't user-facing).

Bonus

You can get the shared SVG icons folder with the amazing UX team at: https://drive.google.com/drive/u/1/folders/1zWdNNezxfntOfi-GhVli6tsxGEQM0ild