How rohith-kanna-jr-2006/nec-faculty-timetable works
NEC’s Faculty Timetable & Workload System supports faculty schedule/workload views and institutional coordinator/HOD management of academic context, allocations, timetable generation, review, and publication. The principal workflow is to prepare course and faculty assignments, create/version timetable sessions, validate workload and scheduling, then move a timetable through HOD approval to publication. The backend exposes role-protected REST operations backed by MongoDB. The README establishes the product capabilities; sampled source confirms selected workload and timetable paths, while several UI and backend integrations remain unsampled.
Main entry points: timetableController.js Timetable API · workloadController.js Workload API · FacultyWorkload.js Workload records · TimetableVersion.js Timetable versions
Components 25
Faculty experience
- Faculty portal
app/(faculty)/dashboard.js - Personal schedule
app/(faculty)/timetable.js - Weekly matrix
app/(faculty)/weekly-timetable.js - Workload validation
app/(faculty)/workload.js - Faculty alerts
app/(faculty)/notifications.js - Faculty profile
app/(faculty)/profile.js
Academic governance
- Course selection
app/coordinator/course-selection.js - Faculty assignment
app/coordinator/faculty-assignment.js - Conflict review
app/coordinator/conflict.js - Faculty allocation
app/hod/faculty-allocation.js - Timetable review
app/hod/timetable-review.js - Approval desk
app/hod/approval.js
Backend API
- REST routes
backend/src/routes/index.js - Workload API
backend/src/controllers/workloadController.js - Timetable API
backend/src/controllers/timetableController.js - Workload calculations
backend/src/services/workloadService.js - Timetable lifecycle
backend/src/services/timetableService.js
Domain state
- Faculty records
backend/src/models/Faculty.js - Workload records
backend/src/models/FacultyWorkload.js - Timetable versions
backend/src/models/TimetableVersion.js - Schedule sessions
backend/src/models/TimetableSession.js
Other components
- Faculty
- Coordinator
- HOD
- MongoDB
Connections 25
- Faculty → Faculty portal: views
- Faculty → Personal schedule: checks schedule
- Faculty → Weekly matrix: views week
- Faculty → Workload validation: checks workload
- Faculty → Faculty alerts: receives alerts
- Faculty → Faculty profile: manages profile
- Coordinator → Course selection: selects courses
- Coordinator → Faculty assignment: assigns faculty
- Coordinator → Conflict review: reviews conflicts
- HOD → Faculty allocation: reviews allocation
- HOD → Timetable review: reviews timetable
- HOD → Approval desk: approves version
- REST routes → Workload API: routes workload
- REST routes → Timetable API: routes timetable
- Workload API → Workload calculations: calculates metrics
backend/src/controllers/workloadController.js - Workload API → Workload records: reads and writes
backend/src/controllers/workloadController.js - Workload calculations → Workload records: aggregates
backend/src/services/workloadService.js - Timetable API → Timetable lifecycle: delegates lifecycle
backend/src/controllers/timetableController.js - Timetable API → Timetable versions: reads versions
backend/src/controllers/timetableController.js - Timetable API → Schedule sessions: manages sessions
backend/src/controllers/timetableController.js - Timetable lifecycle → Timetable versions: transitions state
- Faculty records → MongoDB: persists in
- Workload records → MongoDB: persists in
- Timetable versions → MongoDB: persists in
- Schedule sessions → MongoDB: persists in