🇬🇧 English | 🇮🇷 فارسی
A lightweight, self‑hosted education management platform for tutoring centers, teachers, and small institutes.
Task Box is a fast, mobile‑first web app that helps teachers and small educational institutes run day‑to‑day operations — classes, students, exams, assignments, grades, announcements, and printable reports — from one place. It ships as a Progressive Web App with a fully right‑to‑left Persian interface and the Jalali (Shamsi) calendar.
- Live demo: https://tbx.clonerr.ir
- Repository: https://github.com/Shayan-alinezhad/taskbox
ℹ️ About this repository. This is a public showcase repo. It documents the product, its architecture, and its security posture so developers and users can understand the project. The production backend source code is intentionally not published here.
Small tutoring centers and independent teachers usually juggle spreadsheets, chat groups, and paper to track classes and grades. Task Box replaces that with a single, self‑hosted app that is cheap to run (edge/serverless), works well on phones, and speaks Persian natively — including correct Jalali dates and RTL layout.
- Class, student, exam, assignment, and grade management
- Announcements and simple content pages
- Image uploads with per‑type validation and rate limiting
- Printable report cards / reports
- Customizable branding (site name, banner, colors, menus, slider)
- Role‑aware access (owner/admin vs. regular users)
- Installable PWA with offline‑friendly shell
See FEATURES.md for the full product tour.
| Layer | Technology |
|---|---|
| Runtime | Cloudflare Workers (serverless, edge) |
| Database | Cloudflare D1 (SQLite) |
| File storage | Pluggable bot‑based object storage |
| Frontend | Vanilla JavaScript SPA + PWA (service worker) |
| Localization | Persian (RTL) UI, Jalali calendar |
Task Box is organized into clear layers: a client PWA, a stateless API layer, a relational data layer, an external file‑storage layer, and a cross‑cutting security layer. Full details are in ARCHITECTURE.md.
A hosted demo is available at https://clonerr.ir. Screenshots and walkthroughs live under docs/screenshots/.
Task Box targets the Cloudflare Workers platform.
- Install the Cloudflare CLI (
wrangler). - Create a D1 database and bind it as
DB. - Copy
.env.exampleand provide your own configuration values. - Deploy with
wrangler deploy.
Step‑by‑step guidance is in DEPLOYMENT.md.
All configuration is provided through environment variables / Workers secrets and a D1 binding. Copy .env.example to .env and fill in your own values — never commit real secrets. Variable names and safe placeholders are documented in .env.example and DEPLOYMENT.md.
Security practices (authentication, authorization, input validation, XSS/CSRF protection, secure headers, upload validation, and responsible disclosure) are documented in SECURITY.md. A high‑level summary of hardening work is in PATCHES.md.
Contributions to the documentation and public assets are welcome — see CONTRIBUTING.md.
Released under the MIT License. See LICENSE.