furry-ui
v1.0.0-aplha-1
Published
A React UI Kit/Block
Downloads
5
Maintainers
Readme
Furry UI : WIP
The perfect boilerplate to help you to create your own React UI Kit.
WIP
Contributing
Quick start
Make sure that you have Node v8 or above installed.
- Clone this repo using
git clone [email protected]:juicycleff/furry-ui.git
- Move to the appropriate directory:
cd furry-ui
. - Run
npm ci
in order to install dependencies. - At this point you can run
npm run storybook
to see the example Storybook at http://localhost:6006.
Creating new components
To add a new component, just run npm run generate
. This command will generate all the component (Stateless or not) files for you.
Testing
To test your components run npm test
.
By default we run tests and lint before any push.
Deploying storybook
To deploy storybook to Github Pages run npm run deploy-storybook
.
License
MIT