React + TypeScript + Vite

This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.

Currently, two official plugins are available:

• @vitejs/plugin-react uses Babel (or oxc when used in rolldown-vite) for Fast Refresh
• @vitejs/plugin-react-swc uses SWC for Fast Refresh

Development Instructions

Prerequisites

Before you start, make sure you have installed:

• Node.js (version 18 or newer)
• npm (comes with Node.js) or yarn

Installation

First, install all the required dependencies:

npm install

Or if you're using yarn:

yarn install

Development Server

To start the development server with hot module replacement (HMR):

npm run dev

Or:

yarn dev

The app will be available at http://localhost:5173 (or another port if 5173 is already in use).

Build

To create a production build:

npm run build

Or:

yarn build

The build output will be saved in the dist/ folder.

Preview Production Build

To preview the production build locally:

npm run preview

Or:

yarn preview

Linting

To check your code for errors and style issues:

npm run lint

Or:

yarn lint

Storybook

To start Storybook for component development:

npm run storybook

Or:

yarn storybook

Storybook will be available at http://localhost:6006.

To build Storybook as a static site:

npm run build-storybook

Or:

yarn build-storybook

React Compiler

The React Compiler is not enabled on this template because of its impact on dev & build performances. To add it, see this documentation.

Expanding the ESLint configuration

If you are developing a production application, we recommend updating the configuration to enable type-aware lint rules:

export default defineConfig([
  globalIgnores(['dist']),
  {
    files: ['**/*.{ts,tsx}'],
    extends: [
      // Other configs...

      // Remove tseslint.configs.recommended and replace with this
      tseslint.configs.recommendedTypeChecked,
      // Alternatively, use this for stricter rules
      tseslint.configs.strictTypeChecked,
      // Optionally, add this for stylistic rules
      tseslint.configs.stylisticTypeChecked,

      // Other configs...
    ],
    languageOptions: {
      parserOptions: {
        project: ['./tsconfig.node.json', './tsconfig.app.json'],
        tsconfigRootDir: import.meta.dirname,
      },
      // other options...
    },
  },
]);

You can also install eslint-plugin-react-x and eslint-plugin-react-dom for React-specific lint rules:

// eslint.config.js
import reactX from 'eslint-plugin-react-x';
import reactDom from 'eslint-plugin-react-dom';

export default defineConfig([
  globalIgnores(['dist']),
  {
    files: ['**/*.{ts,tsx}'],
    extends: [
      // Other configs...
      // Enable lint rules for React
      reactX.configs['recommended-typescript'],
      // Enable lint rules for React DOM
      reactDom.configs.recommended,
    ],
    languageOptions: {
      parserOptions: {
        project: ['./tsconfig.node.json', './tsconfig.app.json'],
        tsconfigRootDir: import.meta.dirname,
      },
      // other options...
    },
  },
]);