0.1.0 • Published 4 years ago
smart-react-color v0.1.0
React Components Library Boilerplate
Simple boilerplate for easy creation of own react components library.
Basic usage
- Clone this repo using
git clone git@github.com:emahnovets/react-components-library-boilerplate.git <my-awesome-lib>
- Remove .git directory
rm -rf .git
- Personalize package.json. Changes:
- Name
- Author
- Repository
- Licence
- Initialize git and commit your changes
Features
- Typescript
- TSLint & Prettier (with airbnb config)
- Jest for testing (Enzyme + jest-image-snapshot) (one note: it would be better to use one machine to update and compare image snapshot since rendering can be a bit different from platform to platform)
- Webpack 4
- Storybook for components demo
- CSS Modules (SCSS supported)
- Example component
Tasks
yarn start
- run storybook for development and demoyarn build:storybook
- build components demo with docsyarn build
- build packageyarn lint
- lints components codeyarn test
- perform all tests. (storybook demo should be started using 1st command)yarn format
- format code using prettier
License
react-components-library-boilerplate is available under MIT. See LICENSE for more details.
0.1.0
4 years ago