Repository Architecture

This page maps source folders to runtime behavior so contributors can find code faster.

Top-Level Layout

• server
  • Cargo.toml (workspace root + binary)
  • src
  • api
  • algorithms
  • model
  • migration
  • nominatim
  • macros
• client
  • Vite React app (map + admin UI)
  • src
• docs
  • Nextra docs site (this documentation)
• or-tools
• Dockerfile (multi-stage client + server + OR-Tools build)
• docker-compose.yml

Runtime Request Flow

Rust Workspace Crates

• server: binary entrypoint and workspace root.
• server/api: HTTP layer, auth, route wiring, request/response shaping.
• server/algorithms: clustering, routing, bootstrap logic and plugin execution.
• server/model: SeaORM models/query helpers and scanner-specific data access.
• server/migration: database schema migrations.
• server/nominatim: geosearch client abstraction.
• server/macros: shared proc macros.