# dayastant/student-project-showcase-portal architecture

> Architecture diagram of the GitHub repository dayastant/student-project-showcase-portal, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-01). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/dayastant/student-project-showcase-portal
- Repository: https://github.com/dayastant/student-project-showcase-portal

## Overview

The Student Project Showcase Portal is a full-stack platform for publishing, discovering, and moderating student projects. Its main workflow is Google sign-in, project submission with metadata and images, administrator review, then discovery and social interaction. Staff and administrators also have review, analytics, user-management, and reporting capabilities. The graph combines documented product behavior with relationships visible in the supplied excerpts and SOURCE INDEX; unsampled controller, route, and listener internals limit some connections.

Main entry points: [`backend/src/events/eventBus.js`](https://github.com/dayastant/student-project-showcase-portal/blob/main/backend/src/events/eventBus.js) (Event publisher), [`backend/src/project/project.controller.js`](https://github.com/dayastant/student-project-showcase-portal/blob/main/backend/src/project/project.controller.js) (Project management), [`frontend/src/pages/projects/ProjectDetailPage.jsx`](https://github.com/dayastant/student-project-showcase-portal/blob/main/frontend/src/pages/projects/ProjectDetailPage.jsx) (Project pages), [`backend/src/admin/admin.controller.js`](https://github.com/dayastant/student-project-showcase-portal/blob/main/backend/src/admin/admin.controller.js) (Moderation and roles)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_client["Web experience"]
  node_app["Route application<br/>[App.jsx]"]
  node_projectui["Project pages"]
  node_createui["Project submission"]
  node_lectui["Lecturer dashboard"]
  node_engageui["Reviews and reactions"]
  node_adminui["Admin dashboard<br/>[AdminDashboard.jsx]"]
end

subgraph group_identity["Identity and profiles"]
  node_authctx["Auth context<br/>[AuthContext.jsx]"]
  node_login["Google sign-in<br/>[LoginPage.jsx]"]
  node_profile["Profile management<br/>[ProfilePage.jsx]"]
  node_usersapi["User API client<br/>[users.js]"]
  node_userctrl["User management<br/>[user.controller.js]"]
  node_users[("Users<br/>[user.model.js]")]
end

subgraph group_projects["Project lifecycle"]
  node_projectctrl["Project management"]
  node_projectmodel[("Project records<br/>[project.model.js]")]
  node_projectimages[("Project images")]
  node_approval["Review and approval"]
  node_departments[("Departments")]
end

subgraph group_engagement["Community interaction"]
  node_likectrl["Likes<br/>[like.controller.js]"]
  node_commentsctrl["Comments"]
  node_followctrl["Follows"]
  node_reports["Project reports"]
end

subgraph group_operations["Administration and events"]
  node_adminctrl["Moderation and roles"]
  node_events["Event publisher<br/>[eventBus.js]"]
  node_listeners["Event listeners<br/>[listeners.js]"]
  node_notifications[("Notifications")]
end

node_students(("Students"))
node_staff(("Staff and lecturers"))
node_admins(("Administrators"))
node_mongo[("MongoDB")]
node_api["REST API server<br/>[index.js]"]

node_students -->|"sign in"| node_login
node_login -.->|"establishes session"| node_authctx
node_authctx -->|"loads profile"| node_usersapi
node_usersapi -->|"requests users"| node_api
node_app -->|"provides auth"| node_authctx
node_students -->|"submits project"| node_createui
node_createui -.->|"sends submission"| node_projectctrl
node_projectctrl -->|"creates and updates"| node_projectmodel
node_projectctrl -->|"adds images"| node_projectimages
node_projectctrl -->|"validates department"| node_departments
node_staff -->|"reviews submissions"| node_lectui
node_admins -->|"moderates projects"| node_adminui
node_lectui -->|"approves or rejects"| node_approval
node_approval -->|"updates status"| node_projectmodel
node_adminui -.->|"manages users"| node_adminctrl
node_adminctrl -->|"moderates projects"| node_projectmodel
node_adminctrl -->|"updates users"| node_users
node_projectui -.->|"browses projects"| node_api
node_students -->|"interacts with projects"| node_engageui
node_engageui -.->|"posts reviews"| node_commentsctrl
node_projectui -.->|"likes projects"| node_likectrl
node_profile -.->|"follows students"| node_followctrl
node_projectui -.->|"reports content"| node_reports
node_projectctrl -->|"publishes deletion"| node_events
node_likectrl -->|"publishes like"| node_events
node_commentsctrl -->|"publishes comment"| node_events
node_followctrl -->|"publishes follow"| node_events
node_reports -->|"publishes report"| node_events
node_adminctrl -->|"publishes moderation"| node_events
node_events -->|"dispatches events"| node_listeners
node_listeners -.->|"creates notifications"| node_notifications
node_api -->|"persists application data"| node_mongo
node_projectui -->|"discovers approved projects"| node_projectmodel

click node_app "https://github.com/dayastant/student-project-showcase-portal/blob/main/frontend/src/App.jsx"
click node_authctx "https://github.com/dayastant/student-project-showcase-portal/blob/main/frontend/src/contexts/AuthContext.jsx"
click node_login "https://github.com/dayastant/student-project-showcase-portal/blob/main/frontend/src/pages/login/LoginPage.jsx"
click node_profile "https://github.com/dayastant/student-project-showcase-portal/blob/main/frontend/src/pages/profile/ProfilePage.jsx"
click node_usersapi "https://github.com/dayastant/student-project-showcase-portal/blob/main/frontend/src/api/users.js"
click node_userctrl "https://github.com/dayastant/student-project-showcase-portal/blob/main/backend/src/users/user.controller.js"
click node_users "https://github.com/dayastant/student-project-showcase-portal/blob/main/backend/src/users/user.model.js"
click node_projectui "https://github.com/dayastant/student-project-showcase-portal/blob/main/frontend/src/pages/projects/ProjectDetailPage.jsx"
click node_createui "https://github.com/dayastant/student-project-showcase-portal/blob/main/frontend/src/pages/projects/CreateProjectPage.jsx"
click node_lectui "https://github.com/dayastant/student-project-showcase-portal/blob/main/frontend/src/pages/home/LecturerDashboard.jsx"
click node_projectctrl "https://github.com/dayastant/student-project-showcase-portal/blob/main/backend/src/project/project.controller.js"
click node_projectmodel "https://github.com/dayastant/student-project-showcase-portal/blob/main/backend/src/project/project.model.js"
click node_projectimages "https://github.com/dayastant/student-project-showcase-portal/blob/main/backend/src/projectImages/projectImage.model.js"
click node_approval "https://github.com/dayastant/student-project-showcase-portal/blob/main/backend/src/lecturer/lecturer.controller.js"
click node_departments "https://github.com/dayastant/student-project-showcase-portal/blob/main/backend/src/departments/department.model.js"
click node_engageui "https://github.com/dayastant/student-project-showcase-portal/blob/main/frontend/src/components/AcademicReviewsView.jsx"
click node_likectrl "https://github.com/dayastant/student-project-showcase-portal/blob/main/backend/src/likes/like.controller.js"
click node_commentsctrl "https://github.com/dayastant/student-project-showcase-portal/blob/main/backend/src/comments/comment.controller.js"
click node_followctrl "https://github.com/dayastant/student-project-showcase-portal/blob/main/backend/src/followers/follower.controller.js"
click node_reports "https://github.com/dayastant/student-project-showcase-portal/blob/main/backend/src/reports/report.controller.js"
click node_adminui "https://github.com/dayastant/student-project-showcase-portal/blob/main/frontend/src/pages/home/AdminDashboard.jsx"
click node_adminctrl "https://github.com/dayastant/student-project-showcase-portal/blob/main/backend/src/admin/admin.controller.js"
click node_events "https://github.com/dayastant/student-project-showcase-portal/blob/main/backend/src/events/eventBus.js"
click node_listeners "https://github.com/dayastant/student-project-showcase-portal/blob/main/backend/src/events/listeners.js"
click node_notifications "https://github.com/dayastant/student-project-showcase-portal/blob/main/backend/src/notification/notification.controller.js"
click node_api "https://github.com/dayastant/student-project-showcase-portal/blob/main/backend/index.js"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_app,node_projectui,node_createui,node_lectui,node_engageui,node_adminui toneBlue
class node_authctx,node_login,node_profile,node_usersapi,node_userctrl,node_users,node_mongo toneAmber
class node_projectctrl,node_projectmodel,node_projectimages,node_approval,node_departments,node_api toneMint
class node_likectrl,node_commentsctrl,node_followctrl,node_reports toneRose
class node_adminctrl,node_events,node_listeners,node_notifications,node_students,node_staff,node_admins toneIndigo
```

## Components

### Web experience

- [Route application](https://github.com/dayastant/student-project-showcase-portal/blob/main/frontend/src/App.jsx): `frontend/src/App.jsx`
- [Project pages](https://github.com/dayastant/student-project-showcase-portal/blob/main/frontend/src/pages/projects/ProjectDetailPage.jsx): `frontend/src/pages/projects/ProjectDetailPage.jsx`
- [Project submission](https://github.com/dayastant/student-project-showcase-portal/blob/main/frontend/src/pages/projects/CreateProjectPage.jsx): `frontend/src/pages/projects/CreateProjectPage.jsx`
- [Lecturer dashboard](https://github.com/dayastant/student-project-showcase-portal/blob/main/frontend/src/pages/home/LecturerDashboard.jsx): `frontend/src/pages/home/LecturerDashboard.jsx`
- [Reviews and reactions](https://github.com/dayastant/student-project-showcase-portal/blob/main/frontend/src/components/AcademicReviewsView.jsx): `frontend/src/components/AcademicReviewsView.jsx`
- [Admin dashboard](https://github.com/dayastant/student-project-showcase-portal/blob/main/frontend/src/pages/home/AdminDashboard.jsx): `frontend/src/pages/home/AdminDashboard.jsx`

### Identity and profiles

- [Auth context](https://github.com/dayastant/student-project-showcase-portal/blob/main/frontend/src/contexts/AuthContext.jsx): `frontend/src/contexts/AuthContext.jsx`
- [Google sign-in](https://github.com/dayastant/student-project-showcase-portal/blob/main/frontend/src/pages/login/LoginPage.jsx): `frontend/src/pages/login/LoginPage.jsx`
- [Profile management](https://github.com/dayastant/student-project-showcase-portal/blob/main/frontend/src/pages/profile/ProfilePage.jsx): `frontend/src/pages/profile/ProfilePage.jsx`
- [User API client](https://github.com/dayastant/student-project-showcase-portal/blob/main/frontend/src/api/users.js): `frontend/src/api/users.js`
- [User management](https://github.com/dayastant/student-project-showcase-portal/blob/main/backend/src/users/user.controller.js): `backend/src/users/user.controller.js`
- [Users](https://github.com/dayastant/student-project-showcase-portal/blob/main/backend/src/users/user.model.js): `backend/src/users/user.model.js`

### Project lifecycle

- [Project management](https://github.com/dayastant/student-project-showcase-portal/blob/main/backend/src/project/project.controller.js): `backend/src/project/project.controller.js`
- [Project records](https://github.com/dayastant/student-project-showcase-portal/blob/main/backend/src/project/project.model.js): `backend/src/project/project.model.js`
- [Project images](https://github.com/dayastant/student-project-showcase-portal/blob/main/backend/src/projectImages/projectImage.model.js): `backend/src/projectImages/projectImage.model.js`
- [Review and approval](https://github.com/dayastant/student-project-showcase-portal/blob/main/backend/src/lecturer/lecturer.controller.js): `backend/src/lecturer/lecturer.controller.js`
- [Departments](https://github.com/dayastant/student-project-showcase-portal/blob/main/backend/src/departments/department.model.js): `backend/src/departments/department.model.js`

### Community interaction

- [Likes](https://github.com/dayastant/student-project-showcase-portal/blob/main/backend/src/likes/like.controller.js): `backend/src/likes/like.controller.js`
- [Comments](https://github.com/dayastant/student-project-showcase-portal/blob/main/backend/src/comments/comment.controller.js): `backend/src/comments/comment.controller.js`
- [Follows](https://github.com/dayastant/student-project-showcase-portal/blob/main/backend/src/followers/follower.controller.js): `backend/src/followers/follower.controller.js`
- [Project reports](https://github.com/dayastant/student-project-showcase-portal/blob/main/backend/src/reports/report.controller.js): `backend/src/reports/report.controller.js`

### Administration and events

- [Moderation and roles](https://github.com/dayastant/student-project-showcase-portal/blob/main/backend/src/admin/admin.controller.js): `backend/src/admin/admin.controller.js`
- [Event publisher](https://github.com/dayastant/student-project-showcase-portal/blob/main/backend/src/events/eventBus.js): `backend/src/events/eventBus.js`
- [Event listeners](https://github.com/dayastant/student-project-showcase-portal/blob/main/backend/src/events/listeners.js): `backend/src/events/listeners.js`
- [Notifications](https://github.com/dayastant/student-project-showcase-portal/blob/main/backend/src/notification/notification.controller.js): `backend/src/notification/notification.controller.js`

### Other components

- **Students**
- **Staff and lecturers**
- **Administrators**
- **MongoDB**
- [REST API server](https://github.com/dayastant/student-project-showcase-portal/blob/main/backend/index.js): `backend/index.js`

## Connections

- Students → Google sign-in: sign in (evidence: `README.md`)
- Google sign-in → Auth context: establishes session
- Auth context → User API client: loads profile (evidence: `frontend/src/contexts/AuthContext.jsx`)
- User API client → REST API server: requests users (evidence: `frontend/src/api/users.js`)
- Route application → Auth context: provides auth (evidence: `frontend/src/App.jsx`)
- Students → Project submission: submits project (evidence: `README.md`)
- Project submission → Project management: sends submission
- Project management → Project records: creates and updates (evidence: `backend/src/project/project.controller.js`)
- Project management → Project images: adds images (evidence: `backend/src/project/project.controller.js`)
- Project management → Departments: validates department (evidence: `backend/src/project/project.controller.js`)
- Staff and lecturers → Lecturer dashboard: reviews submissions (evidence: `README.md`)
- Administrators → Admin dashboard: moderates projects (evidence: `README.md`)
- Lecturer dashboard → Review and approval: approves or rejects (evidence: `frontend/src/pages/home/LecturerDashboard.jsx`)
- Review and approval → Project records: updates status (evidence: `backend/src/lecturer/lecturer.controller.js`)
- Admin dashboard → Moderation and roles: manages users
- Moderation and roles → Project records: moderates projects (evidence: `backend/src/admin/admin.controller.js`)
- Moderation and roles → Users: updates users (evidence: `backend/src/admin/admin.controller.js`)
- Project pages → REST API server: browses projects
- Students → Reviews and reactions: interacts with projects (evidence: `README.md`)
- Reviews and reactions → Comments: posts reviews
- Project pages → Likes: likes projects
- Profile management → Follows: follows students
- Project pages → Project reports: reports content
- Project management → Event publisher: publishes deletion (evidence: `backend/src/project/project.controller.js`)
- Likes → Event publisher: publishes like (evidence: `backend/src/likes/like.controller.js`)
- Comments → Event publisher: publishes comment (evidence: `backend/src/comments/comment.controller.js`)
- Follows → Event publisher: publishes follow (evidence: `backend/src/followers/follower.controller.js`)
- Project reports → Event publisher: publishes report (evidence: `backend/src/reports/report.controller.js`)
- Moderation and roles → Event publisher: publishes moderation (evidence: `backend/src/admin/admin.controller.js`)
- Event publisher → Event listeners: dispatches events
- Event listeners → Notifications: creates notifications
- REST API server → MongoDB: persists application data (evidence: `README.md`)
- Project pages → Project records: discovers approved projects (evidence: `README.md`)
