Run the platform locally

For development, run the backend and the frontend separately. The frontend’s development server forwards every request under /api to the backend on 127.0.0.1:8000.

You need a near-optimal set: either a local directory (see Build a dataset for the platform) or the URL of a published archive, such as https://github.com/EINS-TUDa/MGA-Compass/releases/download/<tag>/near-optimal-set.zip.

Backend

From app/backend:

uv sync --package mgaserver

Then start it with a local set:

DATA_DIR=/path/to/set uv run uvicorn mgaserver.main:app --reload --port 8000

or with a published one, which is downloaded and unpacked into data/ on startup:

DATASET_URL=https://github.com/EINS-TUDa/MGA-Compass/releases/download/<tag>/near-optimal-set.zip \
    uv run uvicorn mgaserver.main:app --reload --port 8000

A local archive works too, as a file:// URL. On Windows PowerShell, set the variable first, e.g. $env:DATA_DIR = "C:\path\to\set".

The server refuses to start if a file of the set is missing, its checksum doesn’t match, or the set breaks a rule of the format. All settings are listed in Server settings.

Frontend

From app/frontend, with Node.js installed:

npm install
npm run dev

Open the address Vite prints, http://localhost:5173 by default.