A template for creating React packages.
To install this package use npm:
npm install @your-scope/react-package-template
For local development, use Yalc to install this package in your project.
Yalc is a tool for managing local development of npm packages. It allows you to work on this package locally and test it in other projects without publishing to the npm registry.
To use yalc, you need to install it globally on your machine. You can do this using npm:
npm install yalc -g
First, navigate to the project directory where you want to use this package and run:
yalc add @your-scope/react-package-template
This will install the package from the local Yalc store. You can now use it in the project as you would with any other npm package.
After publishing changes to this package to the local Yalc store, navigate to the project directory and run:
yalc update @your-scope/react-package-template
This will update the installed version of this package in the project.
In the project directory, you can run:
Builds production files in your dist/
folder. It generates CommonJS, ES Modules, as well as TypeScript declaration files.
Builds CommonJS (CJS) modules for the project.
Builds ES Modules (ESM) for the project.
Generates TypeScript declaration files.
Removes the dist/
folder to ensure a clean build.
Formats the code using Prettier according to the rules defined in package.json.
Runs the Storybook component explorer. Open http://localhost:6006 to view it in the browser.
Builds Storybook as a static web application. Useful for deploying to a static hosting service or sharing with others.
Runs the test suite for the project using Jest.
Runs the test suite in watch mode, re-running tests when files change.
Runs the test suite and generates a coverage report.
Publishes the package to the local Yalc store for local development.
Publishes updates to the package in the local Yalc store and pushes the changes to linked projects.
This repository is configured to publish the package to npm, every time you publish a new release, using GitHub Actions.
To publish the package, you need an npm token:
- Log in to your npm account.
- Navigate to Access Tokens in your npm account settings.
- Generate a new token with the Automation option, especially if you have 2FA enabled.
- Add the token to your GitHub repository secrets:
- Go to Settings > Secrets and variables > Actions.
- Add a new secret named
NPM_TOKEN
and paste your npm token.