How bhargava1424/sat works
Project Type and Purpose
• Full‑stack Student Assessment Tracking (SAT) system
• Frontend: React SPA for managing students, teachers, sessions, assessments, ECAs, and feedback
• Backend: Node.js/Express API with MongoDB for data persistence and business logic
Main System Components
A. Frontend (React)
• Components: Dashboard, Authentication (AuthContext), Modals (AddAttendance, AssessmentModal, etc.), Charts (Chart.js/Recharts)
• Public assets: index.html, manifest.json
• State & routing: React Context API, React Router DOM
• Styling: TailwindCSS, DaisyUI
• API calls: Axios to /api/* endpoints
B. Backend (Express)
• Entry: app.js
• Routes: authentication, teachers, students, assessments, sessions, branches, feedbacks, ECAs, clusters, drive
• Middleware: uploadMiddleware (Multer), error handler, JWT validation
• Business logic: server/utils/services.js
• Email: Nodemailer for notifications & password reset
• Google Drive: server/config/googleConfig.js for file storage integration
C. Database
• MongoDB via Mongoose models: Teacher, Student, Assessment, Feedback, ECA, Branch, Cluster, Session
D. External Services
• SMTP server (via Nodemailer)
• Google Drive API
• (Potential) third‑party services for analytics or hosting
Component Interactions and Data Flows
• User opens web browser → React SPA served by frontend build (port 3001)
• React makes HTTP(S) requests (Axios) to Express API (/api/auth/*, /api/students, etc.)
• Express routes invoke controller logic → Mongoose queries to MongoDB
• File uploads: React uploads files via form data → Express Multer middleware → Google Drive or local storage
• Authentication: React stores session/token → JWT sent with each request → Express middleware validates role-based access
• Notifications: Express triggers Nodemailer to send emails on certain events (password reset, feedback alerts)
Architectural Patterns and Design Principles
• Separation of concerns: clear split between UI, API, and data layers
• MVC‑style organization in backend (Routes → Models → Services)
• Component-driven UI with reusable hooks & context
• RESTful API design with resource-based endpoints
• Role-based access control enforced via middleware
• Environment-based configuration (.env files for API endpoints, DB URIs, secrets)
Detailed Elements
• Clear labels: “React SPA”, “Express API”, “MongoDB Atlas”
• Rounded rectangles for UI components
• Standard rectangles for services and databases
• Configuration notes: environment variables for ports, DB URIs, API keys
Final Checklist
• [ ] All major components (frontend, backend, database, external services) represented
• [ ] Data flows between tiers clearly indicated
• [ ] Architectural patterns (REST, MVC, middleware) annotated
• [ ] Technology stack noted alongside each component