https://github.com/denysvuika/react-lib

Project template for a React library
https://github.com/denysvuika/react-lib

boilerplate library react reactjs template

Last synced: 3 months ago
JSON representation

Project template for a React library

• Host: GitHub
• URL: https://github.com/denysvuika/react-lib
• Owner: DenysVuika
• License: mit
• Created: 2020-06-15T07:28:00.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-03-05T21:19:11.000Z (almost 2 years ago)
• Last Synced: 2024-04-15T03:03:59.813Z (10 months ago)
• Topics: boilerplate, library, react, reactjs, template
• Language: JavaScript
• Size: 752 KB
• Stars: 15
• Watchers: 3
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# react-lib

Project template for a React library with TypeScript support

## Features

- [TypeScript](https://www.typescriptlang.org/) support

- [React](https://reactjs.org/) support

- CSS Modules with [PostCSS](https://postcss.org/)

- [ESLint](https://eslint.org/) (with [React](https://reactjs.org/) and [Prettier](https://prettier.io/))

- Unit tests ([Jest](https://jestjs.io/) and [Testing Library](https://testing-library.com/))

- Minified output with [Terser](https://terser.org/)

- Bundle size validation with [size-limit](https://github.com/ai/size-limit)

- Flexible builds with [Rollup](https://www.rollupjs.org/)

- [CHANGELOG.md](https://keepachangelog.com/en/1.0.0/) template

## Getting started

- Clone the project or click "Use this template" button on GitHub

- Update the `package.json` with your project details

- Update `README.md` and `CHANGELOG.md`

- Build the project: `yarn build` or `npm run build`

  - Validate output bundle size with `yarn size` or `npm run size`

- Lint the project: `yarn lint` or `npm run lint`

- Run unit tests: `yarn test` or `npm test`