This is a library with customized chakra-ui components.
Getting Started
- Install dependencies:
yarn
- Install optional dependencies:
yarn global add nps
- See scripts by running
nps
or./node_modules/.bin/nps
:-
nps dev
- Run Storybook locally -
nps build
- Build Storybook and the TypeScript project for deployment -
nps lint
- Core Linting -
nps meta
- Build a visualization of the codebase -
nps test
- Run tests -
nps care
- Auto-run on commit-hook
-
Releases
Our releases are based on tags. In order to do a release:
- Update
package.json
version, submit a PR and merge it tomaster
. - Run
git tag -a "vX.Y.Z" -m "ui-kit@X.Y.Z"
where X.Y.Z is the major.minor.patch version. - Run
git push --tags
Local Development
Running nps dev
will launch storybook server with components examples on http://localhost:5000
where all available component can be tested and configured.