Install degit
globally:
bun i -g degit || pnpm i -g degit || yarn global add degit || npm i -g degit
Scaffold the project:
# basic template w/ react-router-dom
degit rajput-hemant/react-template-vite <project-name>
cd <project-name>
# basic template w/ tanstack-router
degit rajput-hemant/react-template-vite#tanstack-router <project-name>
cd <project-name>
# barebone template
degit rajput-hemant/react-template-vite#barebone <project-name>
cd <project-name>
Install dependencies:
bun i || pnpm i || yarn || npm i
Initialize a new git repository (Optional):
git init
git add .
git commit --no-verify -m "init"
In the project directory, you can run:
Script | Description |
---|---|
dev |
Runs the app in the development mode. |
build |
Builds the app for production to the dist folder. |
serve |
Serves the production build from the dist folder. |
preview |
Bundles and serves the production build from the dist folder. |
type-check |
Runs TypeScript type-checking. |
lint |
Runs ESLint with Prettier. |
fmt |
Formats the code with Prettier. |
fmt:check |
Checks if the code is formatted with Prettier. |
prepare |
Installs husky git hooks. |
package.json
with your project details.README.md
with your project details.LICENSE
with your name and year.index.html
to your liking.This template uses bun as the default package manager. If you want to use pnpm
, npm
or yarn
, you need to remove the bun.lockb
file and run pnpm i
, npm i
or yarn
to generate the lock file for the respective package manager.
This project is licensed under the MIT License - see the LICENSE file for details.
Note: It may take up to 24h for the contrib.rocks plugin to update because it's refreshed once a day.