First hour with Sigra

Copy Markdown View Source

Goal: Land a green local loop: deps → install → migrate → server → register → confirm → log in — in about one hour including reading.

Reading map (shortest path)

  1. Installation — add the dependency and run the installer.
  2. Getting started — happy-path walkthrough this guide assumes you will run.
  3. Production checklist (deployment recipe) — HTTPS, sessions, and proxy checks before a public host.
  4. If something breaks: Troubleshooting install.
  5. Upgrading an existing Sigra host: Upgrading toward v1.7 (Nyquist / OAuth audit / CI context) · Upgrading toward v1.8 (post–v1.7 doc polish + Hex bump checklist).
  6. After the first hour: toward solo production — ordered reading after the green loop, without duplicating deployment tables.
  7. Generator and install options — canonical mix sigra.install flag matrix and cross-links.

Checklist

  • [ ] PostgreSQL reachable (localhost:5432 or your URL); credentials match config/dev.exs.
  • [ ] {:sigra, "~> 0.2"} (or current published range) in mix.exs; mix deps.get.
  • [ ] mix sigra.install (use --yes in CI or scripts); then mix ecto.migrate.
  • [ ] mix test in the host app passes (or at least compiles) before layering optional features.
  • [ ] mix phx.server — open /users/register, complete getting-started flow.

When every box is checked, continue with After the first hour: toward solo production for mail semantics, the production checklist anchor, and MFA depth—still without leaving the intro track.

Optional features (later same day)

Only after the checklist is green:

Maintainer / CI truth

If you are contributing to Sigra itself, local mix test expects Postgres — see repository CLAUDE.md / CONTRIBUTING.md for the exact env vars and Docker one-liner.