s0wlz (Matthias Puchstein)
f3f570a63e
- Add test-* and seed-demo Make targets to command reference - Document TT_TEST_MODE, /health route, test_reset route module - Expand admin subroutes list, add Testing and CI sections - Fix SQLx contradiction (runtime queries, no DATABASE_URL needed) - Rewrite GEMINI.md with full Claude parity - Add root README.md with quickstart, stack, and doc links
35 lines
1.1 KiB
Markdown
35 lines
1.1 KiB
Markdown
# TutorTool
|
|
|
|
Attendance tracker for tutoring sessions. Tutors manage courses, rooms, and slots; students check in via a public QR code link. Live at [tutor.puchstein.dev](https://tutor.puchstein.dev).
|
|
|
|
## Quickstart
|
|
|
|
```bash
|
|
make dev
|
|
# Backend: http://localhost:3000
|
|
# Frontend: http://localhost:5173
|
|
```
|
|
|
|
Demo credentials: `admin@tutortool.com` / `admin`
|
|
|
|
## Stack
|
|
|
|
- **Backend**: Rust + Axum + SQLite (via SQLx), JWT auth
|
|
- **Frontend**: SvelteKit 5 (Svelte runes), TypeScript, adapter-static (SPA)
|
|
- **Build**: Vite + Cargo; 3-stage Docker build for production
|
|
|
|
## Documentation
|
|
|
|
| Doc | Contents |
|
|
|---|---|
|
|
| [`CLAUDE.md`](CLAUDE.md) | Agent guidance: commands, architecture, conventions |
|
|
| [`GEMINI.md`](GEMINI.md) | Same, with Gemini-specific context |
|
|
| [`docs/testing.md`](docs/testing.md) | E2E test pipeline (Playwright + test daemon) |
|
|
| [`docs/specs/`](docs/specs/) | Feature specs |
|
|
| [`docs/plans/`](docs/plans/) | Implementation plans |
|
|
| [`docs/design_handoff/`](docs/design_handoff/) | UI design mocks |
|
|
|
|
## Deployment
|
|
|
|
Kubernetes via `k8s/` manifests on ITSH Cloud (tenant-5, Hetzner). CI via Gitea Actions at `.gitea/workflows/test.yml`.
|