t1112000/tutor-management-app
t1112000/tutor-management-app has 110 GitHub stars and 84 forks. GitHot measured 0 stars in 24 hours, 0 in 7 days, and 0 in 15 days. Last checked 2026-11-19 12:56 UTC. Last push 2026-11-03.
What you can do
- Students — profiles, subjects, soft-delete safety
- Schedules — recurring weekly slots (dayOfWeek + HH:MM)
- Bills & sessions — generate sessions, mark paid/unpaid, edit session notes
- Calendar — session view + fixed weekly schedule view
Measured star growth
- in 24h
- 0
- in 7 days
- 0
- in 15 days
- 0
- in 1 month
- Collecting history
Net star changes over overlapping periods, not daily totals. Missing measurements are left blank. Stars measure attention, not software quality.
About
MyClass — open-source private tutoring management (students, schedules, bills, VN timezone). Next.js 15 + Postgres. Self-hosted.
Self-hostedREADME.md
OriginalMyClass — Tutor Management App
MyClass is an open-source, self-hosted web app for private tutors. Manage students, weekly schedules, session billing, calendar views, and PWA push reminders — with Vietnam timezone (Asia/Ho_Chi_Minh) and VND money formatting built in.
Designed for a single tutor (one account owns their students). Not a multi-tenant marketplace.
Why this project exists
Most scheduling/billing tools assume multi-teacher centers or SaaS subscriptions. MyClass is built for independent tutors who want to self-host student schedules and invoices, with correct Vietnam calendar semantics and soft-delete data safety. If you teach privately and already run Docker (or can), you can run the whole stack on one machine.
Features
- Students — profiles, subjects, soft-delete safety
- Schedules — recurring weekly slots (
dayOfWeek+HH:MM) - Bills & sessions — generate sessions, mark paid/unpaid, edit session notes
- Calendar — session view + fixed weekly schedule view
- Report — monthly and all-time invoice totals, full bill list, TanStack Charts visualizations
- Settings — profile, notification preferences, web push
- PWA — installable; offline shell caching (API never cached)
- Docker — Postgres + app + nightly DB backups
Stack
- Next.js 15 (App Router) · TypeScript · TanStack Query · TanStack Charts
- PostgreSQL · Sequelize · umzug migrations
- NextAuth (email + password / credentials)
- Tailwind CSS · Radix UI · Vitest (pure logic)
Prerequisites
Quick start (Docker)
git clone https://github.com/t1112000/tutor-management-app.git
cd tutor-management-app
cp .env.example .env
Edit .env and set at least:
| Variable | Notes |
|---|---|
AUTH_SECRET |
Random secret (e.g. openssl rand -base64 32) |
NEXT_PUBLIC_APP_URL |
Public URL (e.g. http://localhost:3000) |
| VAPID keys | Optional for push; generate with npx web-push generate-vapid-keys |
docker compose up --build
App: http://localhost:3000 (port may match your compose mapping).
Create the first user (from a machine with Node, against the same DB):
yarn install
yarn set-password <email> <password> [name]
Bắt đầu nhanh (Tiếng Việt)
Hướng dẫn tóm tắt bằng Tiếng Việt để chạy thử MyClass qua Docker. Xem phần Quick start (Docker) và Environment ở trên nếu cần chi tiết đầy đủ về biến môi trường.
- Clone repo:
git clone https://github.com/t1112000/tutor-management-app.git - Vào thư mục dự án:
cd tutor-management-app - Tạo file cấu hình:
cp .env.example .env - Mở
.envvà điền các biến bắt buộc (AUTH_SECRET,NEXT_PUBLIC_APP_URL, v.v. — xem bảng ở phần Quick start phía trên). Không commit file.envhay bất kỳ secret nào. - Khởi chạy toàn bộ stack:
docker compose up --build - Mở ứng dụng tại
http://localhost:3000 - Tạo tài khoản đầu tiên:
yarn install, sau đóyarn set-password <email> <mat-khau> [ten] - Đăng nhập lần đầu bằng email và mật khẩu vừa tạo ở bước 7
Local development
cp .env.example .env
# Point DATABASE_URL at a local Postgres instance
yarn install
yarn db:migrate
yarn set-password [email protected] 'your-password' 'Your Name'
yarn dev
Scripts
| Command | Description |
|---|---|
yarn dev |
Next.js dev server |
yarn build / yarn start |
Production build & serve |
yarn typecheck |
tsc --noEmit |
yarn lint |
ESLint |
yarn test |
Vitest (pure logic only) |
yarn db:migrate |
Apply migrations |
yarn db:migrate:undo |
Undo last migration |
yarn set-password |
Create/update a user password |
CI runs typecheck → lint → test → build on every PR to main.
Environment
See .env.example. Required at runtime:
DATABASE_URLAUTH_SECRETAUTH_TRUST_HOST(typicallytruebehind a reverse proxy)
Web push (optional but needed for reminders on device):
NEXT_PUBLIC_VAPID_PUBLIC_KEY(inlined at build time)VAPID_PRIVATE_KEYVAPID_EMAIL(e.g.mailto:[email protected])
NEXT_PUBLIC_* values are baked into the client bundle at build time. With Docker, pass them as build args (already wired in docker-compose.yml).
Architecture notes
- Ownership: every API route uses
requireUser()and scopes data withfindOwnedStudent/findOwnedBill(createdBy+deletedAt: null). - Soft deletes:
StudentandBillare soft-deleted; queries must filterdeletedAtthemselves (helpers do this). - Time: all date logic uses helpers in
src/lib/time.ts(Vietnam time). Prefer those over rawDate/ UTC assumptions. - Single replica: daily reminders (
node-cronat 07:00 VN) and the in-process sign-in rate limiter assume one app instance. Multiple replicas will duplicate reminders.
iOS PWA push
Web push on iOS requires iOS 16.4+ and the app added to the Home Screen. Notifications are not delivered in Safari tabs — only standalone/PWA mode.
Screenshots
Product UI lives under the dashboard routes (/students, /bills, /calendar, /report).
Community-contributed screenshots (no real PII) can go in docs/screenshots/ — see open issues labeled good first issue.
Contributing
Contributions are welcome — docs, bugfixes, accessibility, and carefully scoped features. See CONTRIBUTING.md.
Looking for a first task? Check good first issues or the templates in docs/good-first-issues.md.
Please read SECURITY.md for vulnerability reports and CODE_OF_CONDUCT.md.
Maintainers / Codex
Agent-oriented project notes: AGENTS.md, CLAUDE.md.
OSS readiness & Codex for Open Source checklist: docs/oss-scorecard.md.
License
MIT — free to use, modify, and self-host.