React UI Kit boilerplate
The perfect boilerplate to help you to create your own React UI Kit.
- Components generators
- Development Environment: Storybook
- Styles: Styled Components with theming configuration
- Lint: TSLint
- Tests: Jest
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:
npm ciin order to install dependencies.
- At this point you can run
npm run storybookto 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.
To test your components run
npm test. By default we run tests and lint before any push.
To deploy storybook to Github Pages run
npm run deploy-storybook.