Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/boilertown/react-ui-boilerplate
The boilerplate to help you build React UI library and publish to NPM automatically.
https://github.com/boilertown/react-ui-boilerplate
front-end library npm react-boilerplate react-ui rollup storybook testing-library typescript
Last synced: 28 days ago
JSON representation
The boilerplate to help you build React UI library and publish to NPM automatically.
- Host: GitHub
- URL: https://github.com/boilertown/react-ui-boilerplate
- Owner: boilertown
- License: mit
- Created: 2022-07-25T08:38:48.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-03-01T13:11:15.000Z (over 1 year ago)
- Last Synced: 2024-10-08T12:25:27.197Z (about 1 month ago)
- Topics: front-end, library, npm, react-boilerplate, react-ui, rollup, storybook, testing-library, typescript
- Language: TypeScript
- Homepage: https://react-ui-boilerplate-navy.vercel.app
- Size: 1.78 MB
- Stars: 55
- Watchers: 1
- Forks: 4
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
♨️ React UI Boilerplate
A React boilerplate with opinionated setup to help you quickly create your own React UI library.
## The Setup
- [React v18][react-url]
- [TypeScript][typescript-url]
- UI development with [Storybook][storybook-url]
- Unit test with [Testing-library][testing-library-url]
- Linting with [Eslint][eslint-url] and code formatting with [Prettier][prettier-url]
- Conventional commit messages with [Commitlint][commitlint-url]
- Build the library with [Rollup][rollup-url]
- Automated release with [changesets][changesets-url]
## Get Started
- Use [Boilertown](https://github.com/boilertown/create-boilertown) CLI.
```sh
# 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.
[Ref: Github Docs](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template)
## Development
- Build the library:
```sh
pnpm build
```
- Run storybook:
```sh
pnpm storybook
```
- Unit test component with:
```sh
pnpm test
```
- Create changeset:
```sh
pnpm changeset
```
## Release & Publish package
This boilerplate uses [changesets][changesets-url] to automatically generate `CHANGELOG`, create releases and publish to NPM registry via GitHub Actions. You can see action details at [release.yml](/.github/workflows//release.yml).
To automating publish your library, follow these steps:
- Create a `NPM_TOKEN`. [See this article for more details](https://docs.npmjs.com/creating-and-viewing-access-tokens). Make sure the type of access token is **Automation**.
- [Follow this instruction](https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository) to add the created token to your GitHub Actions secrets. Name of the secret is `NPM_TOKEN`.
- Install [changeset bot](https://github.com/apps/changeset-bot).
- [Adding changeset and commit](https://github.com/changesets/changesets/blob/main/docs/adding-a-changeset.md#i-am-in-a-single-package-repository).
**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.
## Contributing
**react-ui-boilerplate** ❤️ your contributions. If you have any ideas, suggestions, fixes, feel free to contribute.
[boilertown-url]: https://github.com/boilertown
[react-url]: https://beta.reactjs.org
[typescript-url]: https://www.typescriptlang.org
[storybook-url]: https://storybook.js.org
[eslint-url]: https://eslint.org
[commitlint-url]: https://github.com/conventional-changelog/commitlint
[prettier-url]: https://prettier.io
[testing-library-url]: https://testing-library.com
[rollup-url]: https://rollupjs.org
[changesets-url]: https://github.com/changesets/changesets