Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/boilertown/react-minimal-v2-boilerplate
Minimal React boilerplate to help you quickly kickstart your applications. Use @antfu/eslint-config.
https://github.com/boilertown/react-minimal-v2-boilerplate
eslint react typescript vite
Last synced: 7 days ago
JSON representation
Minimal React boilerplate to help you quickly kickstart your applications. Use @antfu/eslint-config.
- Host: GitHub
- URL: https://github.com/boilertown/react-minimal-v2-boilerplate
- Owner: boilertown
- License: mit
- Created: 2022-10-05T08:31:07.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-01-12T06:48:29.000Z (almost 2 years ago)
- Last Synced: 2024-11-09T11:12:23.818Z (2 months ago)
- Topics: eslint, react, typescript, vite
- Language: TypeScript
- Homepage:
- Size: 449 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
♨️ React Minimal Boilerplate - 2nd Edition
A React boilerplate with mininal setup to help you quickly kickstart your applications.
## Introduction
This setup is simplier than [react-nostalgia-boilerplate](https://github.com/boilertown/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](https://vitejs.dev/config/build-options.html#build-target), 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-url]
- [React Router v6][react-router-url]
- [TypeScript][typescript-url]
- Unit test with [Testing-library][testing-library-url]
- Linting and code formating with [Eslint][eslint-url] and [@antfu/eslint-config](https://github.com/antfu/eslint-config)
- Develop and build production with [Vite][vite-url]
## Get Started
- Use [Boilertown](https://github.com/boilertown/create-boilertown) CLI.
```sh
# 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.
[Ref: Github Docs](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template)
## Development
- Run the app in development environment:
```sh
pnpm dev
```
- Run components unit tests with jest:
```sh
pnpm test
```
- Build the app in production mode:
```sh
pnpm build
```
- Run the app in production mode. It uses static files from `build` folder.
```sh
pnpm serve
```
## Contributing
**react-minimal-v2-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
[react-router-url]: https://reactrouter.com
[typescript-url]: https://www.typescriptlang.org
[eslint-url]: https://eslint.org
[testing-library-url]: https://testing-library.com
[vite-url]: https://vitejs.dev