This repo is intended to be used as a starter template for creating react pacakges.
This repo uses Bun.
To develop your app locally run bun install
and then bun run dev
.
Once you have your npm login authenticated in your terminal/command prompt or equivalent (.npmrc file), you can run bun run publish
to execute the included publish script.
This script will:
- Type check your code ✅
- Lint your code 🧹
- Format your code 🧠
- Test your code (if you have any tests you need to uncomment the part of the script that runs tests) 🧪
- Build your code 🧰
- Ask you to select if this is a patch, minor, or major version change. This will adjust your package.json accordingly and create a tag commit. ✅
- Run another build so the package version update is included in the published code ✅
- Attempt to run
npm publish
to publish your package! 🚀