Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Macro Monitor

An open-source, provenance-first macroeconomic monitor. The Web MVP covers only verified U.S. Treasury 2-year and 10-year yields and their same-day 10Y–2Y spread. It does not include predictions, trading signals, accounts, payments, or synthetic observations.

Run

npm install
npm run db:init
npm run ingest:treasury   # downloads the current year's official data
npm run dev               # open http://localhost:3000

FRED requires FRED_API_KEY in the environment; secrets are never stored in YAML or Git. When ingestion has not run or retrieval fails, the dashboard explicitly displays Unavailable.

Structure

config/                 source and indicator registries
data/raw/               ignored immutable source responses
docs/                   architecture and source decisions
scripts/                database and ingestion commands
src/adapters/           source adapters and contract
src/app/                Next.js pages and API
src/components/         provenance-aware ECharts dashboard
src/db/                 canonical schema and repository boundary
src/domain/             observation contract
src/ingestion/          archive/validate/persist pipeline
src/validation/         quality checks
tests/                  adapter and normalization tests

Complete in phase one

  • TypeScript/Next.js/ECharts initialization and responsive dashboard layout.
  • Canonical SQLite schema containing all required provenance fields; repository interface allows a later PostgreSQL implementation.
  • Adapter contract, Treasury implementation, FRED implementation, and an explicitly unavailable NBS skeleton.
  • YAML registries; raw-response archival; duplicate, missing, chronology, unit, and jump validation.
  • Official Treasury 2Y/10Y retrieval and transparent 10Y–2Y derivation; source and timestamps on every card.
  • Unit tests for adapter mapping and normalization/validation.

Not complete

  • PostgreSQL repository, scheduled ingestion, retry/alerting, and multi-year backfill orchestration.
  • Verified NBS series mappings and ingestion; global country coverage.
  • Authentication, billing, desktop packaging, forecasting, and trading signals (deliberately out of scope).

See architecture and data source notes.

About

macro-monitor

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages