A modern minimal Vite + React + TypeScript template with pre-configured ESLint (with Airbnb JS/React rules), Prettier, Testing with Jest and Git hooks with Husky out of the box 📦
- ⚡️ Vite - Next Generation Frontend Tooling
- ⚛️ React 18 - A JavaScript library for building user interfaces
- 💎 TypeScript - Why not?!
- 🔨 EsLint - Pluggable JavaScript linter
- 🌀 Prettier - Opinionated Code Formatter
- 🐺 Husky - Native Git hooks
- ⚙️ Jest - Testing libraries
- ⌨️ Absolute Imports
- 📑 Commitlint - Linting your commits based on commit convention
This template arose out of a need to unite all the above libraries, which were not found in the existing Vite templates. This template has an active contributors that will update everything on this template as needed
npx degit potreco/viterc my-app
cd my-app
# Required if you want a repository and work with Git hooks
git init
yarn install
yarn devIn this project, you can run the following scripts:
| Script | Description |
|---|---|
| yarn dev | Runs the app in the development mode. |
| yarn build | Builds the app for production to the dist folder. |
| yarn preview | Builds the app for production to the dist folder, and run locally server. |
| yarn lint | Runs the Eslint and show code problems |
| yarn lint:fix | Runs the Eslint and fix the code problems |
| yarn format | Runs the Prettier and fix code style |
| yarn compile | Runs the TS Compiling |
| yarn test | Run the app tests. |
| yarn commit | Open the CZ CLI to create a message to your commit. |
To correctly functioning (code and tests) of absolute imports, you should add some codes in some files, like:
- jest.config.js
- vite.config.ts
- tsconfig.json
We already writed some absolute imports on these files, so if you wanna more paths or edit some, feel free to do. If your not safe about it or have some question, send us a thread on Github Discussions asking for, we were happy to help
- Eslint
- Prettier
- Husky
- Testing Tools
- Absolute imports
- Commit linting