How divash02/final-year-project works
CollegeOS is a browser-based institutional workspace backed by an Express modular monolith and MongoDB. The principal workflow is: a user enters through the browser, signs in, selects a workspace, and uses its institutional functions; frontend API requests are handled by backend routes and persisted through the database layer. Major capabilities include academics, admissions, LMS and assessments, examinations, documents, timetabling, communications, workflow, and AI. The README describes the overall frontend-to-backend architecture; edges between individual unsampled routes and services are omitted rather than inferred.
Main entry points: app.js Express API · db.js Database and session layer · App.tsx React application · index.js Domain models
Components 25
Browser application
- React application
frontend/src/App.tsx - Session and workspace state
frontend/src/context/CollegeOSContext.tsx - API client
frontend/src/services/apiClient.ts - Login view
frontend/src/components/auth/LoginView.tsx - Document workspace
frontend/src/components/modules/SmartDocumentCentreView.tsx
Access and platform
- Express API
backend/src/app.js - Authentication routes
backend/src/routes/auth.js - Authentication middleware
backend/src/middleware/auth.js - Permission catalog
backend/src/permissions/catalog.js - Database and session layer
backend/src/db.js - Domain models
backend/src/models/index.js
Teaching and learning
- Academic routes
backend/src/routes/academics.js - Attendance routes
backend/src/routes/attendance.js - LMS routes
backend/src/routes/lms.js - Quiz routes
backend/src/routes/quizzes.js - Quiz runtime
backend/src/services/lms/quizEngine.js - Examinations workspace
frontend/src/components/modules/ExaminationWorkspaceView.tsx
Institutional services
- Institutional domain routes
backend/src/routes/administration.js - Admissions routes
backend/src/routes/admissions.js - Document routes
backend/src/routes/documents.js - Workflow engine
backend/src/services/workflowEngine.js
AI and automation
- AI routes
backend/src/routes/ai.js - AI services
backend/src/services/ai
Other components
- Institution user
- MongoDB
Connections 27
- Institution user → React application: uses
README.md - React application → Session and workspace state: provides state
frontend/src/App.tsx - React application → Login view: renders
frontend/src/App.tsx - Session and workspace state → API client: requests API
frontend/src/context/CollegeOSContext.tsx - Document workspace → API client: uploads and requests
frontend/src/components/modules/SmartDocumentCentreView.tsx - React application → Express API: uses backend
README.md - Express API → Authentication routes: registers
backend/src/app.js - Express API → Academic routes: registers
backend/src/app.js - Authentication routes → Database and session layer: authenticates users
backend/src/routes/auth.js - Database and session layer → MongoDB: connects
backend/src/db.js - Database and session layer → Domain models: uses models
backend/src/db.js - Database and session layer → Permission catalog: normalizes roles
backend/src/db.js - Academic routes → Database and session layer: uses database
backend/src/routes/academics.js - Academic routes → Domain models: uses models
backend/src/routes/academics.js - Express API → Attendance routes: registers
backend/src/app.js - Express API → LMS routes: registers
backend/src/app.js - Express API → Quiz routes: registers
backend/src/app.js - Quiz runtime → Domain models: uses quiz models
backend/src/services/lms/quizEngine.js - Quiz runtime → Quiz routes: serves quiz runtime
- Examinations workspace → API client: uses API
- Express API → Institutional domain routes: registers
backend/src/app.js - Express API → Admissions routes: registers
backend/src/app.js - Express API → Document routes: registers
backend/src/app.js - Document workspace → Document routes: requests documents
- Workflow engine → Domain models: uses models
backend/src/services/workflowEngine.js - Express API → AI routes: registers
backend/src/app.js - AI routes → AI services: dispatches AI work