Checkpoint Explorer

Running the full stack with Docker

docker compose up --build -d

Starts three containers — MariaDB, the Rust backend (port 3000), and the frontend (port 5173). Migrations run automatically at backend startup.

To tear down and wipe the database:

docker compose down -v

Running the backend using binary

Start only the database:

docker compose up -d mariadb

Then run the backend:

cd backend
cargo run --bin checkpoint-explorer

The backend reads config from environment variables — see backend/.env.example.

Running the frontend using npm

cd frontend
npm install
npm run dev -- --host

Prerequisites

• Rust (stable) — rustup
• Node.js ≥ 18 — nvm
• just — cargo install just

Functional tests

Requires uv and Docker (the test suite spins up an ephemeral MariaDB container).

cd functional-tests
uv run python entry.py

Code quality

just check      # fmt + clippy + ruff — run before pushing
just lint-fix   # auto-fix clippy suggestions
just fmt        # auto-format Rust code