Local Setup¶

Prerequisites¶

• Java 17+ (project bytecode is enforced up to Java 21)
• Node.js + npm
• Docker (for PostgreSQL/Keycloak and supporting services)
• Python 3 (for MkDocs)

Backend (ects-backend)¶

1. Start dependencies (dev compose)¶

cd ects-backend
docker compose -f docker-compose-dev.yaml up -d

This file provisions PostgreSQL, Keycloak, and a containerized backend profile for dev use.

2. Run backend from source¶

cd ects-backend
./gradlew run

Alternative from IDE:

• Run com.ects.backend.Main
• Use debug.xml or debug-local.xml as config input

3. Backend URL¶

• API base: http://localhost:8082/api (local source run)

Frontend (web-portal)¶

1. Install deps (if needed)¶

cd web-portal
npm install

2. Run dev server¶

cd web-portal
npm start

Default local URL:

• http://localhost:3000 (or Vite host/port overrides)

Environment values are sourced from env.local and public/runtime-config*.js.

Documentation Site (MkDocs)¶

1. Install MkDocs¶

python3 -m pip install mkdocs

2. Serve docs locally¶

mkdocs serve

3. Build static docs¶

mkdocs build

Output is generated in the site/ directory.