The boilerplate to help you build React UI library and publish to NPM automatically.
MIT License
Use Boilertown CLI.
# npm
npm create boilertown -- -b react-ui-boilerplate
# yarn
yarn create boilertown -b react-ui-boilerplate
# pnpm
pnpm create boilertown -b react-ui-boilerplate
# bun
bun create boilertown/react-ui-boilerplate [library-name]
Click the green "Use this template" button to generate a new repository with the same structure and files.
Build the library:
pnpm build
Run storybook:
pnpm storybook
Unit test component with:
pnpm test
Create changeset:
pnpm changeset
This boilerplate uses changesets to automatically generate CHANGELOG
, create releases and publish to NPM registry via GitHub Actions. You can see action details at release.yml.
To automating publish your library, follow these steps:
Create a NPM_TOKEN
. See this article for more details. Make sure the type of access token is Automation.
Follow this instruction to add the created token to your GitHub Actions secrets. Name of the secret is NPM_TOKEN
.
Install changeset bot.
P/S: Remember to check the Allow GitHub Actions to create and approve pull requests
in your repo Settings > Actions > General & scroll to Workflow permissions.
react-ui-boilerplate ❤️ your contributions. If you have any ideas, suggestions, fixes, feel free to contribute.