How athulnath03/automatic-timetable-and-schedule-generator works
This is a small full-stack web application:
• Frontend: React (Vite) “dashboard” UI (frontend/)
• Backend: Flask API + static file hosting (backend/app.py)
• Core domain logic: a timetable generator (greedy scheduler) in backend/scheduler.py
• Primary user flow: user configures timetable inputs in the UI → UI calls Flask /api/generate → backend runs scheduler → returns generated timetable → UI renders and optionally saves/displays it.
• Two-tier app (browser UI + API server)
• API contract (/api/health, /api/generate)
• Runtime modes: dev mode (Vite + Flask separate) vs prod mode (Flask serves built static assets)
• Internal backend decomposition: routing layer vs scheduler module
Generate flow
• User enters:
• days, periods_per_day, classes, subjects[{name, teacher, periods_per_week}]
• Frontend sends JSON → POST /api/generate
• Backend validates/parses JSON → calls scheduler.py
• Scheduler returns “timetable structure” → Flask returns JSON
• Frontend renders result in TimetableView
Health flow
• Frontend/dev tools/curl → GET /api/health → simple JSON status
Static asset flow (prod)
• Browser GET / and /assets/* → Flask serves from frontend/dist
• [ ] Shows React+Vite frontend and Flask backend as separate deployable/run components
• [ ] Shows /api/generate calling backend/scheduler.py
• [ ] Shows dev ports (5173 and 5000) and CORS note
• [ ] Shows prod static hosting from frontend/dist by Flask
• [ ] Does not show a DB unless you confirm one exists