Awesome
<h1 align="center">♨️ React Minimal Boilerplate - 2nd Edition</h1> <div align="center"> <p> A React boilerplate with mininal setup to help you quickly kickstart your applications. </p> <img src="https://img.shields.io/github/license/boilertown/react-minimal-v2-boilerplate?style=flat-square" alt="MIT license" > </div>Introduction
This setup is simplier than react-nostalgia-boilerplate version.
- Use
Vite
to develop locally and create bundle for production. - Use
Vitest
to perform Unit test.
This boilerplate by default, targets browsers which support the native ES Modules, native ESM dynamic import, and import.meta
. You can specify custom targets via Vite build.target config option, where the lowest target is es2015
.
The setup is opinionated as it is based on my experience of working with difference React projects. It works very well to me and my team. I hope I can make you feel the same.
The Setup
- React v18
- React Router v6
- TypeScript
- Unit test with Testing-library
- Linting and code formating with Eslint and @antfu/eslint-config
- Develop and build production with Vite
Get Started
-
Use Boilertown CLI.
# npm npm create boilertown@latest -- -b react-minimal-v2-boilerplate # yarn yarn create boilertown -b react-minimal-v2-boilerplate # pnpm pnpm create boilertown -b react-minimal-v2-boilerplate # bun bun create boilertown/react-minimal-v2-boilerplate [project-name]
-
Click the green "Use this template" button to generate a new repository with the same structure and files.
<img src="https://docs.github.com/assets/cb-36544/images/help/repository/use-this-template-button.png" alt="Use this template button" width="500">
Development
-
Run the app in development environment:
pnpm dev
-
Run components unit tests with jest:
pnpm test
-
Build the app in production mode:
pnpm build
-
Run the app in production mode. It uses static files from
build
folder.pnpm serve
Contributing
react-minimal-v2-boilerplate ❤️ your contributions. If you have any ideas, suggestions, fixes, feel free to contribute.