How harshitgupta2610/aicte-portal-f works
Project Type & Purpose
• This is a full-stack web application developed for the Smart India Hackathon 2023. Its purpose is to provide a unified, secure web portal for collaboratively designing and managing technical university curriculums. Major features include real-time chat and notifications, versioning of curriculum data, user authentication/authorization, feedback analysis, a central resource repository, PDF downloads for curriculums, and access control management.
Architectural Components Identified from the File Tree and README
a. Frontend Client
• Found under the “client” directory – A React-based application.
• Contains component hierarchies, pages (login, dashboard, curriculum editing, profile, etc.), context providers for state management (for courses, filters, subjects, and users), hooks, and styling (Tailwind CSS configuration).
• Typical folders: client/src/components, client/src/context, client/src/pages.
b. Backend Server
• Entry point: server.js along with app.js that appears to bootstrap the application.
• Uses Express (inferred by the “controllers”, “routes”, “middlewares”, and “models” directories), following an MVC-like pattern.
• Controllers handle core business logic (e.g., authController.js, courseController.js, subjectController.js) and interact with Models defining data structures.
• Routes (e.g., authRoute.js, courseRoute.js) expose RESTful endpoints.
• Middleware (errorHandler.js) and error utilities provide robust error management.
• Real-time aspects are covered by a “socket” directory (e.g., socket/index.js) for chat/notifications.
c. Auxiliary Services and Utilities
• PDF Generation: The “pdfCreation” directory contains HTML templates and scripts for generating downloadable PDF curriculums.
• Email & Other Utility Functions: The “utils” directory provides common functionality needed by the backend (e.g., email sending, pdfUtils, typeConversion).
• Docker & Deployment: Dockerfile, docker-compose.yml, and environment example files suggest containerization for deployment.
d. Implicit/Inferred Components
• Database: Though not explicitly defined, the models suggest a data store (likely MongoDB or a similar NoSQL database) used by the backend.
• External Services: Authentication and role management for AICTE staff and collaborators imply integration with external email systems or authentication providers.
• Below the API layer, branch out to:
• Database (CRUD operations)
• WebSocket/Real-Time Service (for live chats and notifications)
• PDF Generation Service (for curriculum downloads)
• External Email Service (for user notifications and verification)
• Enclose Docker symbols near both the frontend and backend to represent containerization.