Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rajarakoto/react-boilerplate
Minimalistic boilerplate to quick-start React.js development in TypeScript, optimized for blazing-fast performance Bun & Vite 🚀
https://github.com/rajarakoto/react-boilerplate
boilerplate bun bunjs minimalist react reactjs starter template typescript vite vitejs
Last synced: 4 days ago
JSON representation
Minimalistic boilerplate to quick-start React.js development in TypeScript, optimized for blazing-fast performance Bun & Vite 🚀
- Host: GitHub
- URL: https://github.com/rajarakoto/react-boilerplate
- Owner: RajaRakoto
- License: mit
- Created: 2024-01-17T12:59:26.000Z (8 months ago)
- Default Branch: master
- Last Pushed: 2024-09-10T21:52:51.000Z (18 days ago)
- Last Synced: 2024-09-21T05:32:22.623Z (7 days ago)
- Topics: boilerplate, bun, bunjs, minimalist, react, reactjs, starter, template, typescript, vite, vitejs
- Language: TypeScript
- Homepage:
- Size: 2.02 MB
- Stars: 7
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# react-boilerplate 🚀
[](https://forthebadge.com) [](https://forthebadge.com) [](https://forthebadge.com) [](https://forthebadge.com) [](https://forthebadge.com)
 
**Developer Ready: A comprehensive template. Works out of the box for most React.js projects. This project is intended to be used with the latest active release of React.js.**
Instant Value - All basic tools included and configured:
- 🚀 Typescript >= 5.5.4
- 🌐 React.js >= 18.3.1
- 🧅 Use Bun as package manager
- 🌈 ESM
- 🧹 ESlint with some initial rules recommendation
- 🧪 Biome for code formatting and linting
- ✅ Jest or Bun test for fast unit testing and code coverage
- 📚 Type definitions for Bun.js and Jest
- 🎨 Prettier to enforce consistent code style
- ⚙️ EditorConfig for consistent coding style
- 📦 NPM scripts for common operations
- 📝 Simple example of Tsx code
- 🐗 Run tasks with Grunt (example for backup)
- 🖥️ Ungit for version control (git) with a GUI
- ⚡ Use Vite for lightning fast HMR (hot reload)
- ⚡ Optimized build by Vite
- 🧪 E2E test with Playwright
- 🐳 Containerization for easy deployment and scaling with Docker
- 🧺 Pre-configured setup for Redux or Zustand as state manager, easily removable if not needed
- 🌀 Tailwind CSS already set up with PostCSS for flexible usage
- 🩷 Sass extends CSS with features like variables, nested rules, mixins, imports, inheritance, built-in functions, and more ...
> You can customize your website faster with [PLUM](https://github.com/RajaRakoto/plum), a mixins toolset powered by SASS. Quickly produce consistent, scalable CSS output, regardless of project size. For the best experience, it is recommended to use SASS version `1.77.6` to ensure smooth integration with PLUM.
---
### 📌 Usage
To use this template, use the following commands:
```bash
bun create github.com/RajaRakoto/react-boilerplate
cd
bun run pkg-upgrade # to upgrade outdated dependencies in interactive mode
```
> 1. This starter kit uses the MIT license with my name and GitHub profile—update or remove if needed.
> 2. Each subdirectory in `src` has a `README.md` to explain its structure.
> 3. Adjust the `package.json` (name, description, author, etc.) to fit your project.
---
### 📌 Deployment
Instructions are provided for deploying both with and without Docker. Both options still require a platform to host the application.
**Without Docker**: Deploying is as easy as running the following command and pointing your web server to the generated `index.html` file found at `dist/index.html`
```bash
bun run build
```
**With Docker**: A Dockerfile with an [NGINX](https://www.nginx.com/) base image is also provided for quick and easy deployments. Simply execute the following commands:
```bash
bun run build
docker build . -t # eg: docker build . -t todo-app
docker run -p :80 # eg: docker run todo-app -p 8080:80
```
---
### 📌 NPM Scripts
**Preview**
- 📜 `preview` - Run your app with preview mode.
**Clean**
- 📜 `clean` - Remove coverage data, prod folder, playwright-report ...
**Development**
- 📜 `dev` - Launch Vite.js development server using hot module remplacement (HMR).
**Build**
- 📜 `build` - Build faster with Vite.js.
**Testing**
- 📜 `test:unit` - Run unit testing with Bun.js.
- 📜 `test:unit:watch` - Interactive watch mode to automatically re-run unit testing with Bun.js.
- 📜 `test:e2e` - Run end to end (e2e) testing with Playwright.
**Linting and Formatting**
- 📜 `biome:start` - Starts the Biome daemon server. You can specify a custom configuration file path using the `--config-path` option.
- 📜 `biome:stop` - Stops the Biome daemon server.
- 📜 `biome:fix` - Runs a source code check and applies automatic fixes (linter & formatter) according to the defined rules.
- 📜 `biome:unsafe` - Works like `biome:fix`, but may apply more invasive or risky changes.
- 📜 `eslint` - Lints the project with ESLint and reports unhandled errors.
- 📜 `prettier` - Formats code according to the `.prettierrc` rules.
**Backup and Dependency Management**
- 📜 `backup` - Backup files with Grunt.
- 📜 `pkg-check` - Check useless dependencies with depcheck.
- 📜 `pkg-upgrade` - Upgrade outdated dependencies (interactive mode) with npm-check-updates.
**Versioning**
- 📜 `versioning` - Start ungit server.
**NPM Commands**
- 📜 `npm-version:major` - Increments the major version number of your project using npm.
- 📜 `npm-version:minor` - Increments the minor version number of your project using npm.
- 📜 `npm-version:patch` - Increments the version patch number of your project using npm.
**NVM**
- 📜 `nvm` - Manage multiple node.js versions. Easily switch between node versions per project to ensure compatibility.
**Scripts**
- 📜 `script:sass-charset` - Adds the @charset "UTF-8" declaration at the beginning of all SCSS files in the project.
---
### 📌 Similar
You can also check out my other starter projects:
- 🚀 [bun-boilerplate](https://github.com/RajaRakoto/bun-boilerplate)
- 🚀 [node-boilerplate](https://github.com/RajaRakoto/node-boilerplate)
- 🚀 [next-boilerplate](https://github.com/RajaRakoto/next-boilerplate)
- 🚀 [qwik-boilerplate](https://github.com/RajaRakoto/qwik-boilerplate)
- 🚀 [vscode-boilerplate](https://github.com/RajaRakoto/vscode-boilerplate)
- 🚀 [cli-boilerplate](https://github.com/RajaRakoto/cli-boilerplate)