Peysich is a school management system that is meant to help schools in ghana andthen africa at large..taking over all the school...the best and easy to use school management system......
# Peysich — School Management SaaS
Multi-tenant school management platform for **Preschool → JHS** (no SHS, no university).
Low-cost at any scale, fast, modular, self-serve subscriptions.
> **Status: Built through Phase 5.** All six roadmap phases are implemented and verified
> (see `docs/08-roadmap.md`). Deployment needs the owner steps in **HANDOFF.md**.
## Run it locally
```bash
docker compose up -d # Postgres (or any PG on :5432, creds in .env.example)
cp .env.example .env
npm install
npm run db:migrate # apply migrations
npm run db:seed # plans + 2 demo schools + users (password123)
npm run db:demo # make St. Mary's a LIVING school: roster, timetable,
# attendance, scores, report cards, fees, homework,
# announcements + demo parent/student/teacher logins
npm run dev
```
Then open `stmarys.localhost:3000` (admin@stmarys.test), `littlestars.localhost:3000`,
`admin.localhost:3000` (platform@peysich.test), or `localhost:3000/signup` for the
self-serve funnel. Payments run in fake mode until Paystack keys exist.
**No wildcard subdomains where you're hosting (e.g. `*.vercel.app`)?** The app falls back
to preview mode on the root host: enter a school at `/t/ `, leave with `/t/exit`,
platform console at `/platform`. Subdomain mode activates automatically once a real
domain + wildcard is configured (see HANDOFF.md §0–1).
## The docs (read in order)
| # | Doc | What it answers |
|---|-----|-----------------|
| 0 | docs/00-overview.md | The whole map — what we are building, in one picture |
| 1 | docs/01-architecture.md | Tech stack, how the pieces talk, why each choice |
| 2 | docs/02-multi-tenancy.md | Tenant model, platform plane vs school plane, data isolation |
| 3 | docs/03-modules.md | The module system, the switchboard, every module we'll ever sell |
| 4 | docs/04-plans-billing.md | The 3 plans + custom, self-serve subscription flow, payments |
| 5 | docs/05-data-model.md | Database schema — core entities and …