Files
bsk/README.md
T
tiennm99 299b27417a feat(polish): error boundary, loading state, README (Phase 8)
- locale-subtree error boundary with retry (no error details leaked)
- app-subtree loading spinner (reduced-motion aware)
- README: built-feature overview + first-run operator setup steps
2026-07-25 13:25:41 +07:00

3.1 KiB
Raw Blame History

BSK (Rewrite)

An educational rewrite of the BSK All-in-One Clinic Management System into a modern web stack.

Original project: lds217/BSK-All-in-One-Clinic-Management-System by @lds217 — a Java/Swing desktop application with a Netty server and SQLite backend, built for small Vietnamese clinics.

This repository is a clean-room reimplementation for learning purposes. No source code is copied from the original; features and data shapes are reimplemented from the upstream README and observable behavior. See NOTICE for full attribution.

Status

Core system implemented (Phases 08). See PLAN.md for the architecture and phased roadmap.

Built: auth + RBAC (allowlist-gated admin bootstrap, rate limiting, audit log); master data (doctors, medicines, services, checkup templates, clinic settings, staff management); patients (VN geo lookup + accent-insensitive search); queue + checkup workflow with realtime; prescriptions + billing (server-authoritative VND totals, cashier mark-paid); imaging (webcam/file capture, ≤200 KB compression, signed URLs, barcode); reports (Vietnamese PDF invoice, Excel export, revenue dashboard); recheck reminders + nightly retention sweep.

First-run setup (operator)

After provisioning Supabase/Upstash/Vercel and pnpm db:push:

  1. Seed the admin allowlist before the first sign-in (or nobody can bootstrap admin):
    INSERT INTO bsk.admin_allowlist (email) VALUES ('you@example.com');
    
  2. Seed Vietnamese geo data (province/ward address dropdowns): pnpm db:seed-geo (see scripts/seed-geo.ts).
  3. Enable Supabase Realtime on bsk.checkups (Database → Replication) for the live queue.
  4. Set CRON_SECRET in Vercel so the nightly media-retention sweep (/api/cron/nightly, scheduled in vercel.json) can authenticate.

See docs/supabase-shared-config.md for the shared-project rules and docs/design-guidelines.md for UI conventions.

Stack

  • pnpm + Next.js 16 (App Router) + TypeScript
  • Supabase (Postgres + Auth + Storage) — shared across personal projects via schema-per-app
  • Upstash Redis + QStash — shared across personal projects via key prefixes
  • Vercel for hosting
  • shadcn/ui + Tailwind CSS

Important disclaimers

  • Educational use only. This codebase is not certified for clinical use and must never be deployed against real patient data. Use synthetic data only.
  • No HIPAA / GDPR compliance is implied or attempted on the free-tier infrastructure.
  • This is a derivative work for learning; if you are the upstream author and would like additional attribution or removal, please open an issue.

Database

After pnpm db:push, run pnpm db:gen-types to refresh types/supabase-bsk.ts.

License

This repository is licensed under the Apache License 2.0. The original project does not currently carry an explicit license; see NOTICE for the attribution stance.