README.md

react-typescript-template

• React/Typescript production-ready project template with all the necessary dev tools so that you can start building your project immediately 🧑🏻‍💻 🚀.
• What does this template come with?
  • Jest for Unit Testing (from create-react-app).
  • Typescript support (from create-react-app).
  • Cypress for E2E Testing.
  • Prettier for code formatting.
  • Husky for git hooks to ensure better commits for your code.

Prerequisites

• Must have git installed.
• Must have Node latest LTS version installed.

How to use this template

Run the command below to create a new project and replace your-project-name with your actual project name:

git clone https://github.com/quangnguyen17/react-typescript-template.git your-project-name

To install project dependencies:

npm install

To start project:

npm run start

To run unit tests:

npm run test

# for CI/CD
npm run test:ci

To run e2e tests:

npm run cy

# for CI/CD
npm run cy:ci

To format your code:

npm run prettier

To create a production build:

npm run build

Husky hooks:

• pre-commit hook runs Prettier code formatting and unit tests.