React JS Boilerplate

Guide

npm install

All environment variables for react application must start with APP_ prefix

To change env prefix change add or remove string from envPrefix variable in vite.config.json

Environtment variables can be accesed using env.<name> or import.meta.env.<name>. Prefix must be included.

Declare env types in src/env.d.ts in ImportMetaEnv interface

The environment variables can be found and modified in the .env file. See .env for default values.

In the project directory, you can run:

Start development build

npm start

build for production.

npm run build

Preview production build

npm run preview

Removes all the files generated by the build process.

npm run clean

Rebuild eslint config from typescript source

npm run lint:build

Finds errors in your code.

npm run lint:check

Fix linting errors.

npm run lint:fix

Fix staged code linting errors.

npm run lint:staged

Fix the code formatting.

npm run prettier:fix

Check the code formatting.

npm run prettier:check

tsconfig.json is for react app typescript configuration.
tsconfig.node.json is for vite and other development tools typescript configuration that will not be included in build result.
If you want to add pre-commit or pre-push git hook you can add the command to run in .husky/pre-commit and .husky/pre-push.
If you want to disable dependabot you need to remove .github/dependabot.yml.
If you want to disable codeql analysis you need to remove .github/workflows/codeql-analysis.yml.