\n A React boilerplate with opinionated setup to help you quickly create your own React UI library.\n
\n![\"MIT](\"https://img.shields.io/github/license/boilertowns/nostalgia-boilerplate?style=flat-square\")
\n\n A React boilerplate with opinionated setup to help you quickly create your own React UI library.\n
\n\n![\"Use](\"https://docs.github.com/assets/cb-36544/images/help/repository/use-this-template-button.png\")
\n\n [Ref: Github Docs](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template)\n\n## Development\n\n- Build the library:\n\n ```sh\n pnpm build\n ```\n\n- Run storybook:\n\n ```sh\n pnpm storybook\n ```\n\n- Unit test component with:\n\n ```sh\n pnpm test\n ```\n\n- Create changeset:\n\n ```sh\n pnpm changeset\n ```\n\n## Release & Publish package\n\nThis 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).\n\nTo automating publish your library, follow these steps:\n\n- 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**.\n\n- [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`.\n\n- Install [changeset bot](https://github.com/apps/changeset-bot).\n\n- [Adding changeset and commit](https://github.com/changesets/changesets/blob/main/docs/adding-a-changeset.md#i-am-in-a-single-package-repository).\n\n**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.\n\n## Contributing\n\n**react-ui-boilerplate** ❤️ your contributions. If you have any ideas, suggestions, fixes, feel free to contribute.\n\n[boilertowns-url]: https://github.com/boilertowns\n[react-url]: https://beta.reactjs.org\n[typescript-url]: https://www.typescriptlang.org\n[storybook-url]: https://storybook.js.org\n[eslint-url]: https://eslint.org\n[commitlint-url]: https://github.com/conventional-changelog/commitlint\n[prettier-url]: https://prettier.io\n[testing-library-url]: https://testing-library.com\n[rollup-url]: https://rollupjs.org\n[changesets-url]: https://github.com/changesets/changesets\n","readmeFilename":"README.md"}