Repository navigation
Releases
Releases · tired-wind/crambot
v0.4.0 — Past papers, student uploads and public site
Added
- Past papers are sorted by type (homework, quiz, midterm, final) and by calendar year, with type filters, year groups and solutions paired to their papers. Academic-year names such as
2023-24 Sem 2are converted to the calendar year of the exam. - Past-paper uploads: anyone can submit a paper, with an optional solution, for review without logging in. Submissions are validated (PDF only, 20 MB limit) and rate-limited per client.
- Review page at
/admin, protected by an admin password with lockout after repeated failures. Reviewers can preview a submission, correct its course, type and semester, then approve or reject it. Approved papers are filed under a standard name. - Contributors page, plus
scripts/sync_contributors.py, which generatesCONTRIBUTORS.mdfrom the live site. - Public demo mode (
DEMO_MODE=1): a bundled mock Canvas and demo past papers, a one-click demo login, and example study data on first visit. Real tokens are rejected. - Dockerfile, Render blueprint, and a Docker Compose + Caddy setup with automatic HTTPS for a server.
- Native deployment for small servers, in
deploy/native/: a systemd service behind an existing Caddy, daily backups of uploads and review records, and a one-command deploy script. - The site is live at https://nuscan.duckdns.org, with demo course data. Past-paper uploads are open.
v0.3.0 — Themes, decorations, CI and documentation
Added
- Public-domain engravings in the status bar and sidebar. Each theme has its own set: meteors and a standing Megalosaurus in light mode, and a resting Iguanodon in moonlight lines in night mode.
- GitHub Actions CI: backend tests on Python 3.11 and 3.13; frontend lint, tests and build on Node 22 and 24.
- English and Chinese README with screenshots, MIT license, security policy, contributing guide.
Changed
- Canvas probe tests moved to
scripts/tests/.
v0.2.0 — One-stop revision site
Added
- FastAPI backend for courses, files, announcements, assignments and past papers, with an enrolment check on every course route.
- In-browser PDF reader. PowerPoint, Word and code files are shown as extracted text.
- Per-course full-text search: SQLite FTS5 with BM25 ranking, incremental background indexing, and document parsing in an isolated process pool.
- Review map: lectures in order with their definitions and theorems or slide topics, exercises paired with solutions, and exam dates from NUSMods.
- All-in-one dashboard: exam countdown, week calendar with Canvas deadlines, course strip, todo cards, pomodoro timer, daily plan, recent files and study heatmap.
- Light "paper" and dark "night reading" themes; dinosaur-and-meteor logo.
- Mock Canvas server and a one-command dev script (
scripts/dev.sh --mock).
v0.1.0 — Canvas API probe
Added
- Canvas API probe that checks what a student access token can read: courses, tabs, files, modules, announcements and assignments.
- Pagination via the
Linkheader, retry with exponential backoff on rate limits, and offline tests against a fake Canvas server.