How meghnakorim/vp-portal works
Project type and purpose
• This is a full-stack web application–the “VP Portal”–that provides a Request Management System.
• Frontend: a React.js single-page application deployed as a static site on AWS S3.
• Backend: a Node.js/Express.js REST API server.
• Database: MongoDB for persisting users and requests.
• File storage: local “uploads” folder (could be swapped for S3) for attachments.
• Email service: SMTP or a mail API for notifications and OTP.
File structure
• Top-level directories:
• frontend/ – React app source, components, pages, context, public assets
• backend/ – Express.js server, controllers, routes, models, middleware, utils, and file uploads
• MVC pattern in backend:
• models/ define Mongoose schemas (User, Request)
• controllers/ implement business logic (auth, request handling, file upload)
• routes/ map HTTP paths to controllers
• scripts/ for initial setup (createAdmin, setupDatabase).
• utils/ for helper functions (sendEmail, sendOtpMail, tempStorage).
• package.json files for each tier describe dependencies.
• GitHub-style README outlines purpose, tech stack, deployment.
README for additional insights
• Describes core flows: user registration, login, submit request, admin approval/rejection with email notifications.
• Tech stack summary: React + MUI + Recharts, Node/Express, MongoDB, AWS S3.
Key details to capture
• Authentication middleware intercepting specific routes.
• Role-based access: admin vs. student/faculty.
• Data flow for critical user stories: Submit Request, Admin Approve/Reject, Email notification.
• Initialization scripts (createAdmin, setupDatabase) can be shown as one-off deployment tasks.
Final recommendations
• Expanded view (subcomponents inside the Express API, including controllers, middleware, utils).
• Iterate with the team to refine any missing external integrations (e.g., authentication provider, monitoring).