Skip to content

Latest commit

 

History

History
20 lines (18 loc) · 1.54 KB

File metadata and controls

20 lines (18 loc) · 1.54 KB

Developer docs

Documentation for developing and self-hosting Data Hub itself, including deploying the web app and AWS infrastructure (see First-time deployment). User, operator, and admin documentation (installing a watcher, adding an instrument, managing tokens) lives on the docs site instead — see the root README for that split.

  • Getting started — development setup, environment variables, running locally
  • Local development — zero-credential dev workflow for the web app + API + database (no watcher / Lambda needed)
  • Architecture — system overview, data flow, and design decisions
  • Testing — per-package test frameworks, the shared test-server fixture, S3 mocking
  • Watcher — CLI commands, configuration, run detection, upload modes
  • Lambda — processing pipeline, supported instruments, adding new instruments
  • Shared library — module reference for data-hub-shared
  • First-time deployment — step-by-step self-hosting guide: database, Vercel web app, and AWS S3 + Lambda
  • CI and deployment — GitHub Actions workflows, branch strategy, and how CI redeploys each piece
  • Run archives — "Download all" flow, cache/dedup model, and on-call runbook
  • Conventions — S3 key layout, instrument IDs, code style, environments