Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
morewings authored Jan 27, 2025
1 parent e2c3159 commit 3cd5be1
Showing 1 changed file with 11 additions and 16 deletions.
27 changes: 11 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,27 +4,22 @@

# React Library Template

This template repository is your shortcut to building awesome React components and libraries! ⚡

[![NPM library Create React App template logo](./design/logo.jpg)](#)
Forget about the tedious setup – we've got you covered. Focus on writing your code, and let this template handle the rest.

With React Library Template Repository, you can focus on developing your React components and libraries without worrying about the configuration and setup.

Read [full documentation](https://dev.to/morewings/fastest-way-to-create-a-react-library-3mi7).
## Features

Visit [Demo Storybook](https://morewings.github.io/react-library-template/).
- **TypeScript & JavaScript**: Write your code in the language you prefer.
- **Blazing fast**: **pnpm** for speedy package management and **Vite** for lightning-fast builds.
- **Husky** enforces pre-commit hooks, **Eslint** and **Stylelint** will keep your code tidy and consistent.
- **Jest** and **react-testing-library** help you write robust tests.
- **Storybook** lets you create interactive demos and docs for your components.
- **Optional Tailwind CSS**: If you're into it, you can easily enable Tailwind CSS for styling.

## Features
See it in action: [Demo Storybook](https://morewings.github.io/react-library-template/)

- Supports **Typescript** and **Javascript**.
- Bundles `commonjs` and `es` module formats.
- [pnpm](https://pnpm.io/) for blazing fast package management.
- [Vite](https://vitejs.dev/) for speedy bundling
- [Husky](https://github.com/typicode/husky) for git hooks.
- [Eslint](https://eslint.org/) and [stylelint](https://stylelint.io/).
- [Rollup](https://rollupjs.org/guide/en/) for bundling.
- [Jest](https://jestjs.io/) and [react-testing-library](https://testing-library.com/docs/react-testing-library/intro) for testing.
- [Storybook](https://storybook.js.org/) for documentation and demo.
- Optional [Tailwind CSS](https://tailwindcss.com/) support.
This template is your starting point for building high-quality React libraries. Clone it, customize it, and let's build something amazing! 🚀

## Quickstart

Expand Down

0 comments on commit 3cd5be1

Please sign in to comment.