Skip to content

Tutorial: First Local Run

Last verified: 2026-07-26 against dev at f0388abb.

This tutorial gets a new contributor to a running local SDP stack. It is intentionally short; use the root README for complete setup details.

Goal

Start the local app, open the frontend, and confirm the backend API docs are available.

Prerequisites

  • Python 3.11+.
  • uv.
  • Node.js 22+ and npm.
  • Docker and Docker Compose.
  • Azure CLI for environment hydration paths.
  • Repository submodules initialized.

Steps

  1. Fetch vendored dependencies.
git submodule update --init --recursive
  1. Prepare local environment files.
make setup-dev-env
  1. Copy the local Casbin policy example if your local backend uses file-backed policy.
cp backend/src/altaforge_sdp/api/middleware/policy.local.csv.example \
   backend/src/altaforge_sdp/api/middleware/policy.local.csv
  1. Start the Docker development stack.
make run-dev

  1. Open the app and API docs.

  2. Frontend: http://localhost:5173

  3. Backend API docs: http://localhost:8000/docs

Success Criteria

  • The frontend loads.
  • The backend /docs page loads.
  • The backend can list or create assessment resources with a valid local org context.

Next