Skip to content

Installation ​

Prerequisites ​

The frontend package manifest defines the application scripts and dependencies. The project documentation identifies Node.js 18 or 20 LTS and npm 9+ or Yarn 1.22+ as development prerequisites. A reachable backend API is needed for server-backed flows.

Install and run the frontend ​

sh
cd front
npm install
npm run dev

The Vite development server is configured by the dev script to use port 6002.

Build and test ​

sh
npm run build
npm run test
npm run lint

These commands run from front/. The test script runs TypeScript tests under src/**/*.test.ts; the checked-in frontend test file is front/src/utils/__tests__/calculations.test.ts.

Run this documentation site ​

From the repository root:

sh
npm install
npm run docs:dev

Other documentation commands are npm run docs:build and npm run docs:preview. They use VitePress with docs/ as the site root.

Backend setup ​

Backend installation, database migration, and deployment instructions are maintained outside this frontend reference. For the database and API service, consult the backend project documentation and verify its current configuration.