Skip to content

README: app, data model, setup and how migrations are gated - #6

Merged
dipakkr merged 2 commits into
mainfrom
readme
Sep 26, 2026
Merged

dipakkr merged 2 commits into
mainfrom
readme

Conversation

@dipakkr

@dipakkr dipakkr commented Sep 26, 2026 •

Copy link
Copy Markdown
Owner

Summary

Rewrites the README so a new engineer (or a judge) understands ledgerly in two minutes: what the app shows, how the data is shaped, how to run it, and how schema changes are gated.

What changed

  • Screenshots: the live dashboard, and a ledgerly migration PR paused at the approval step in TrueForge.
  • What's in the app: each dashboard element and the exact query file behind it; live refresh with red deltas when numbers change underneath you.
  • Data model: tables, row counts and relationships, including the ON DELETE CASCADE from refunds to payments.
  • Known data quirks: 18 double charges (11 refunded), 37 payments of deleted customers, 64 legacy POS payments without a merchant.
  • Run it locally: .env, npm run reset, npm start, a Docker one-liner for Postgres, and what deploy:unsafe demonstrates.
  • Migrations and CI: the required Migration Rehearsal check, protected tables, PII masking, and the one-command onboarding.

How to test

Docs only. The required check passes with "No migration changes".

dipakkr and others added 2 commits September 26, 2026 17:09
…I and protections

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@dipakkr
dipakkr merged commit ba548a2 into main Sep 26, 2026
2 checks passed
@dipakkr
dipakkr deleted the readme branch September 26, 2026 12:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant