A modern minimal Vite + React + TypeScript template with 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
-
To run any ReactJS application you need to configure the environment on your machine.
-
Setting the environment is a simple process, so it's recommended to follow the NodeJS documentation, and if you want, install Yarn as Package Manager.
- Clone this repo to your local machine using:
git clone https://github.com/csorlandi/css-preview-react.git
-
Install project dependencies;
yarn install // or npm install
-
Run development mode
yarn dev // or npm run dev
In 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
To get started...
- 🍴 Fork this repo!
- 👯 Clone this repo to your local machine using
git clone https://github.com/csorlandi/css-preview-react.git
- 🎋 Create your feature branch using
git checkout -b my-feature
- ✅ Commit your changes using
git commit -m 'feat: My new feature'
;
- 📌 Push to the branch using
git push origin my-feature
;
- 🔃 Create a new pull request
After your Pull Request is merged, can you delete your feature branch.
Reach out to me at one of the following places!
- Linktree at @csorlandi
- Linkedin at Claudio Orlandi
- Instagram at Claudio Orlandi
- Youtube at Claudio Orlandi
This project is licensed under the MIT License - see the LICENSE file for details.
Made with 🧡 Enjoy it!