Skip to main content

Prerequisites

  • Node.js 20 or 22 (LTS)
  • Access to the Google Cloud SQL instance + a service account JSON
  • npm (the repo uses npm, not pnpm or yarn)

Setup

Configure

Create .env.local at the repo root with the variables documented in Environment variables. Minimum:

Run

The dev script is hardcoded to port 3000 (next dev --port 3000). To run on another port — e.g. for screenshot capture — bypass the npm script:

No tests

There’s no test framework configured. CI relies on npm run build and npm run lint to catch issues.

Project layout

Path alias

@/* maps to src/*. Imports look like:
Configured in tsconfig.json and next.config.ts.

Where to make changes

ChangeFile(s)
Adjust a CII rating boundarysrc/lib/utils/ciiCalculator.ts
Add a fuel typesrc/lib/utils/fuelEUCalculator.ts
Add an EU countrysrc/lib/utils/portClassifier.ts
Update a regulation phase-inSame files; usually one constant
Add a new reportsrc/lib/services/ReportExportService.ts + src/app/api/reports/...
Add a new dashboard viewsrc/app/<route>/page.tsx + client.tsx + new component in src/components/dashboard/