Skip to content

Develop React Components using storybook for dev, babel for build & release-it for release along with good eslint, prettier & jest configs.

License

Notifications You must be signed in to change notification settings

timelessco/react-components-template

Repository files navigation

React Components Template

React Components Project Boilerplate

Get Started

yarn

Storybook

Start the development server

yarn storybook

Build the storybook

yarn build-storybook

Build

Build the components ready for packages with tree shaking ability into dist folder

yarn build

Release

Release a new version

yarn release

Note: For more info: https://github.com/release-it/release-it

Eslint

Extend react-app configs & react-app/jest configs

Check for the linting errors

yarn lint

Check & automatically fix the linting errors

yarn lint:fix

Prettier

Used in conjuction with Eslint with eslint-plugin-prettier & eslint-config-prettier

Format the workspace files

yarn format

Format the package.json file

yarn format:package

Commit

git add . && yarn commit

Uses gacp

  • Runs Husky to improve the commits.
  • Husky runs Lint Staged as a pre-commit hook to run lintes & formatters
  • Husky lints the commit message with Commitlint

Contributors ✨

Thanks goes to these wonderful people (emoji key):


Navin Moorthy

💻

Anurag Hazra

💻

This project follows the all-contributors specification. Contributions of any kind welcome!