Skip to main content

Local Development

Install dependencies​

From repo root:

npm install

Backend dependencies are Python-based:

cd backend/core-api
python -m venv venv
source venv/bin/activate
pip install -r requirements.txt

Environment setup​

Copy the shared template:

cp .env.example .env

Validate expected local Compose variables:

python3 scripts/validate_env.py --profile local-compose --env-file .env

Do not commit secret values. Document env names only.

Run the full stack​

docker compose up --build

Local URLs:

ServiceURL
Webapphttp://localhost:3000
Backend Core APIhttp://localhost:8000
Backend healthhttp://localhost:8000/health
Backend metricshttp://localhost:8000/metrics
API docshttp://localhost:8000/api/v1/docs
Docusaurus docshttp://localhost:3002

Run individual services​

Frontend:

npm run dev --workspace=apps/webapp
# or
npm run webapp:dev

Backend:

cd backend/core-api
source venv/bin/activate
uvicorn app.main:app --reload --host 0.0.0.0 --port 8000

Docs:

npm run docs:dev
# or
npm --prefix app-doc run start