React Component Library Template

Welcome to my React Component Library template

This template is built with the following technologies:

• Language: TypeScript
• Transpiling: Babel
• Bundling: Rollup
• Visualizatiion: Storybook
• Testing: Jest
• CSS Framework: Tailwind
• Styling: CSS & SCSS
• Linting: ESLint
• Formatting: Prettier
• Lint Staged: Husky
• React Refresh
• Development & Production configurations

Getting Started

Using this template is very simple, follow the following instructions:

1. Fork the repository
2. Create a new repository and select forked repository as template

Or,

1. Clone the repository

git clone https://github.com/divshekhar/react-component-library-template.git

2. Install the dependencies

npm install

3. Start the development server

npm start

4. Build for production

npm run build

Features

• TypeScript for improved code quality and developer experience
• Jest for unit testing
• ESLint for linting and maintaining code consistency
• Prettier for automatic code formatting
• Rollup for bundling and building the application
• Babel for transpiling modern JavaScript to older versions for better browser compatibility
• Storybook for visualization of the developing components
• Tailwind for easy development of components
• CSS & SCSS for styling components
• Husky for running lint-staged, which lints and fixes files before committing
• React Refresh for faster development experience
• Development & Production configurations for different environment settings

Contributing

Please feel free to contribute to this project by submitting issues or pull requests.

License

This project is licensed under the ISC License.

Acknowledgements

Thank you for using this template. I hope it helps you build your next project with ease.