Skip to main content

NPM-Helper-App documentation

Reference docs for Nightingale Process Management (NPM-Helper-App) — a Next.js (App Router) + Supabase HR / payroll application.

What's here​

  • Code reference — every exported symbol in the logic/data layers (src/lib, src/server, src/db, src/types), generated from the TSDoc comments via TypeDoc. UI components and pages are intentionally excluded (they're not an API surface). Uncommented exports render as bare signatures; richer comments → richer docs.
  • REST API — the project's Supabase RPCs (one page per function, with the call signature), generated from the committed PostgREST spec (e.g. send_invoices, void_invoice, backfill_invoice, weekly_billing_run, recompute_draft_invoice).
  • Guides (the Guides tab) — the repo's hand-written docs: architecture decision records (ADRs), runbooks (go-live, cron setup, deploy), and the UX/UI guidelines.

Regenerating​

These references are generated on every build. After a schema change, refresh the REST spec:

npm run spec:pull && npm run clean:rest && npm run gen:rest && npm run build

TypeDoc needs no separate command — it reruns inside build / start. See ADR-0046 for the full setup rationale and the regeneration cheat-sheet.