Docs
The List is a weekly SF Bay Area music listing, published at list.sturgis.me. These guides are for the people who run it and work on it.
- Overview: what The List does, and what it’s built with.
- Architecture: diagrams of the site, the backend and the scheduled jobs.
- Local setup: run the backend, an ingest and the site on your own machine.
- Configuration: environment variables for the backend.
- How ingestion works: from Steve’s page to Shows, Bands and Venues in the database.
- Deployment: the Deploy workflow and its hourly check, the
databranch, backfills and rollbacks. - Weekly Alerts: Saved Filters, the weekly Alert email, and their one-time setup.
- Project structure: where things live in the repository.
The guides are Markdown in the repository’s
docs/guide folder. The design system, the domain
language and the architecture decisions are in
DESIGN.md,
CONTEXT.md and
docs/adr.