-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
37 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,39 @@ | ||
# React Library Template | ||
|
||
With React Template Repository, you can focus on developing your React components and libraries without worrying about the configuration and setup. | ||
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://github.com/morewings/cra-template-npm-library/wiki). | ||
|
||
Visit [Demo Storybook](https://morewings.github.io/cra-template-npm-library). | ||
|
||
## Features | ||
|
||
- 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. | ||
- And [much more](https://github.com/morewings/cra-template-npm-library/wiki). | ||
|
||
## Quickstart | ||
|
||
### Prerequisites | ||
|
||
1. Install **Node** >= 18.x. | ||
2. Install **pnpm**. E.g. `corepack prepare pnpm@latest --activate`. | ||
|
||
|
||
### Installation | ||
|
||
Manually clone repo or use `degit`. | ||
|
||
```shell script | ||
npx degit https://github.com/morewings/react-library-template my-library | ||
cd ./my-library | ||
pnpm i | ||
``` | ||
|