Getting Started

This is the shortest path from nothing to a working build. Running the editor and the rest of the local stack is on Development Environment.

Prerequisites

• Rust. The exact version is pinned in rust-toolchain.toml; rustup picks it up automatically.
• just, the command runner. Use the just recipes rather than calling cargo yourself: they are what CI and the pre-commit hooks run.
• Node.js, for the frontends and for the script tests that just check runs.
• Docker, for the tests that start a PostgreSQL container.
• mold, on x86_64 Linux (dev containers included). packages/.cargo/config.toml links with mold there, so a build fails without it. just dev-setup installs it; see One-time setup.

Clone and build

Check that everything passes

This runs what CI runs: formatting, clippy, a build check, schema and annotation validation, the script test suites, and the full Rust test suite. The last step needs Docker. On a machine without it, run just test-no-docker instead, which skips the container-backed crates.

just on its own lists every recipe. Testing explains which one to run when.

Next steps

• Development Environment - the editor and the rest of the local stack, and the pre-commit hooks
• Law Format - how laws are structured
• Architecture - the components and where their code lives
• Contributing - branches, commits and pull requests