aurora-ui-kit
v0.0.22
Published
Dashboard-oriented UI kit built with React, Typescript and JSS
Downloads
10
Maintainers
Readme
React UI Kit boilerplate
The perfect boilerplate to help you to create your own React UI Kit.
Live Example
https://leandrooriente.github.io/react-ui-kit-boilerplate
Features
- Typescript
- Components generators
- Development Environment: Storybook
- Styles: Styled Components with theming configuration
- Lint: TSLint
- Tests: Jest
Quick start
Make sure that you have Node v8 or above installed.
- Clone this repo using
git clone [email protected]:leandrooriente/react-ui-kit-boilerplate.git
- Move to the appropriate directory:
cd react-ui-kit-boilerplate
. - 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