Key Features • How To Use • How To Use • Application Structure • Credits • License
-
🔥 Built with Vite. Blazing fast 🚀
-
🤗 Typescript support default.
-
👮 Eslint and Prettier configured
- Eslint and prettier configured together for auto save format and error checks
-
🐶 husky for git hooks.
- No commit is allowed with errors in code.
- lint-staged will only check errors in staged files.
-
👼 Commitizen for pretty commit message.
-
🍵 Kept very minimal. Only the App and Main file.
To clone and run this application, you'll need Git and Node.js (which comes with npm) installed on your computer. Recommended to use Yarn for the project.
Setup the environtment based on your OS following instruactions from here
From your command line:
# Clone this repository
$ git clone repo-link
# Go into the repository
$ cd react-vite
# Install dependencies
$ yarn install or npm i
# Run the app
$ yarn dev
The directory layout of this boilerplate
.
├── .vscode # Vscode config, for autoformat on save.
├── node_modules # NPM dependency folder
├── src # Source directory for the React Application
├── index.html # The main html file
├── tsconfig.json # Configure typescript
├── tsconfig.node.json # Configure typescript for node and vite
├── package.json # The NPM config file for all the packages installed and scripts and more
├── .eslintrc.js # Configure Eslint
├── .gitignore # ignore certain files for git (example: .env)
├── .prettierrc.js # Configure prettier (example: .env)
├── vite.config.ts # Configure vite
This software uses the following open source packages:
MIT