https://github.com/raisiqueira/react-lib-template

A template to create a React Library. Zero configuration, just use!
https://github.com/raisiqueira/react-lib-template

jest parcel-bundler react-library template-repository typescript

Last synced: 28 days ago
JSON representation

A template to create a React Library. Zero configuration, just use!

• Host: GitHub
• URL: https://github.com/raisiqueira/react-lib-template
• Owner: raisiqueira
• License: mit
• Created: 2022-01-13T22:00:11.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2022-08-03T22:23:44.000Z (over 2 years ago)
• Last Synced: 2024-05-02T05:34:06.024Z (6 months ago)
• Topics: jest, parcel-bundler, react-library, template-repository, typescript
• Language: TypeScript
• Homepage:
• Size: 630 KB
• Stars: 14
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
React lib template 📦


A simple React lib template based on [Parcel](https://parceljs.org/) and [Jest](https://jestjs.io/).

## Usage

use this template for your next React lib, modify it and run `npm run dev` to see it in action.

## Commands

This library has some built-in commands, like: `dev`, `build`, `lint` and `format`.

### `dev`

This command will start a development server with hot reloading and [React Fast Refresh](https://reactnative.dev/docs/fast-refresh).

### `build`

This command will build the library for production, but before, it's run the TypeScript type checking.

### `lint`

This command will run the [ESLint](https://eslint.org/) linter on the code and check for errors.

### `lint:fix`

This command will run the [ESLint](https://eslint.org/) linter on the code and check for errors, and if there are any, it will fix them.

### `format`

This command will run the [prettier](https://prettier.io/) formatter on the code and check for errors.

## JavaScript module formats

Parcel is configured to export a CJS and ESModule. See more on [Parcel's documentation](https://parceljs.org/features/targets/).

## Continuous Integration

### GitHub Actions

- `CI` with installs deps and runs `yarn run lint`, `yarn run build`.

- `size` witch comments const comparation of your library on every pull request.

## Sponsors

[![Sponsors](https://cdn.jsdelivr.net/gh/raisiqueira/static/sponsors.svg)](https://headless-stepper.netlify.app/sponsors)

## License

MIT