Quickstart¶

You need Python 3.11+, uv 0.13.4+ and Docker. In an empty directory, generate an application from the published alpha:

uvx --from "sandloom[standard]==0.7.0a6" sandloom new myapp --with identity,tenancy,billing

This starter selects all three standard modules. For a minimal backend, use uvx --from "sandloom==0.7.0a6" sandloom new myapp --no-batteries --module notes instead. That command already creates notes, so its printed steps add a different module; the other steps are the same. The README demonstrates that minimal path.

sandloom new prints the next steps; run them as printed:

cd myapp
uv sync                                                       # the app, the framework, the pinned dev tools
uv run sandloom generate                                      # snapshots, stubs and DTOs from installed dependencies
docker compose -f deploy/docker-compose.dev.yml up -d --wait  # Postgres + Redis
uv run sandloom add module notes                              # a module: discovered, nothing to wire
uv run sandloom test                                          # tests + every gate (never writes)
uv run sandloom migrate upgrade-all --apply                   # core + module chains
uv run uvicorn myapp.asgi:app --reload                        # http://localhost:8000/health

uv run sandloom test ends with sandloom test: OK; the API answers on http://localhost:8000 (/health, and /api/v1/notes/items with a bearer token). The CI job quickstart (tools/smoke/quickstart_check.py) runs these lines during full validation. See CI profiles for the automatic and full checks.

For an app created with --with identity, follow authentication and email to receive verification mail locally and obtain access/refresh tokens.

Next¶

1. Your project structure: what sandloom new generated, which files are yours and which are generated.
2. Tutorial: your first feature: an application with two modules, a table, routes, an event consumed exactly once, a contract call and tests.