Skip to content

Latest commit

 

History

History

README.md

Checkmate-Escrow Frontend

React + TypeScript + Vite frontend for the Checkmate-Escrow platform.

Local Development

Prerequisites

  • Node.js 18+
  • npm

Setup

cd frontend
npm install

Running the dev server

npm run dev

The dev server starts on http://localhost:5173 by default.

API proxy (CORS)

During local development, requests to /api are automatically proxied to the event-indexer at http://localhost:8080, avoiding CORS errors. Start the event-indexer on port 8080 before running the frontend.

Running tests

npm test

Running tests with coverage

To run tests with coverage reporting:

npm run test:coverage

Or using the longer form:

npm test -- --coverage

This will generate:

  • Console output showing coverage percentages
  • HTML coverage report in the coverage/ directory
  • JSON coverage data for CI/CD integration

The project enforces minimum coverage thresholds:

  • Lines: 70%
  • Functions: 70%
  • Branches: 60%

Tests will fail if coverage falls below these thresholds.

Building for production

npm run build

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

Currently, two official plugins are available:

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...
    },
  },
])