# iamaniket10/session-tracker-portal architecture

> Architecture diagram of the GitHub repository iamaniket10/session-tracker-portal, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-03-30). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/iamaniket10/session-tracker-portal
- Repository: https://github.com/iamaniket10/session-tracker-portal

## Overview

##### Main Components
- Frontend Component:
- Built using Next.js 13+ with TypeScript, TailwindCSS, and shadcn/ui.
- Key directories: “frontend/src/app” (pages for login, signup, sessions, homework, admin session creation) and “frontend/src/components” (UI elements, layout components, forms, etc.).
- Handles user login/signup, session and homework views, and interactive components such as accordions and forms.
- Backend Component:
- Built on Node.js with Express.js, using MongoDB Atlas.
- Key directories: “backend/controllers” (for session, homework, user, and notification operations), “backend/models” (Mongoose models for Homework, Notification, Session, SessionDetail, and User), “backend/routes” (mapping HTTP routes to controllers), and “backend/middleware” (for authentication and error handling).
- Database:
- MongoDB Atlas serves as the storage for user data, session details, homework tasks, and notifications.
- External Services:
- JWT and bcrypt for authentication and security.
- Axios (on the frontend) for making API requests.
- External deployment services: Frontend on Vercel, backend on Render.

##### Relationships and Interactions
- User Interface → Frontend:
- Users interact via web browsers with pages built using Next.js.
- Visual components (e.g., login forms, session accordions, homework task views) form part of the client-side.
- Frontend ↔ Backend:
- The frontend uses Axios to communicate with the backend’s REST API endpoints for sessions, homework, notifications, and user management.
- Backend Internal Flow:
- Routes: Map incoming HTTP requests to controllers.
- Controllers: Contain the business logic (e.g., session management, homework creation, notifications processing).
- Middleware: Enforces authentication and error handling on relevant routes.
- Models: Represent and persist data in MongoDB.
- Security & Data Handling:
- Security layers (JWT for authentication, bcrypt for password hashing) within the backend.
- Error middleware as part of the request pipeline.

##### Architectural Patterns and Design Principles
- Separation of Concerns:
- Frontend and backend are clearly segregated into distinct directories and services.
- MVC-like patterns on the backend: Models for data, Controllers for business logic, and Routes for HTTP endpoints.
- Role-Based Access Control:
- Differentiate admin-only functionalities (creating sessions, editing tasks) versus client functionalities (viewing sessions/homework).
- API-First Design:
- The backend acts as a RESTful API service interfacing with the database and frontend.

- Detail key sub-components:
- Within the frontend, mark out directories/pages such as “admin creation session,” “homework management,” and “session details.”
- External dependencies like Axios on the frontend and external deployment services (Vercel, Render).

## Diagram (Mermaid)

```mermaid
flowchart TD

  %% External User
  User["User/Browser"]:::external

  %% Presentation Layer
  subgraph "Presentation Layer"
    subgraph "UI Components"
      FE_App["Pages & Routing"]:::frontend
      subgraph "Auth & Forms"
        FE_LoginPage["Login Page"]:::frontend
        FE_SignupPage["Signup Page"]:::frontend
        FE_LoginForm["Login Form"]:::frontend
        FE_SignupForm["Signup Form"]:::frontend
      end
      subgraph "Sessions"
        FE_SessionsPage["Sessions Page"]:::frontend
        FE_SessionDetail["Session Details"]:::frontend
        FE_SessionAccordion["Session Accordion"]:::frontend
        FE_SessionOverview["Session Overview"]:::frontend
        FE_EditableCell["Editable Cell"]:::frontend
      end
      subgraph "Homework"
        FE_HomeworkPage["Homework Page"]:::frontend
        FE_HomeworkManagement["Homework Management"]:::frontend
      end
      subgraph "UI Library"
        FE_UI["UI Library Components"]:::frontend
      end
      subgraph "Styling & Theming"
        FE_Globals["Global Styling"]:::frontend
        FE_ThemeProvider["Theme Provider"]:::frontend
        FE_ThemeToggle["Theme Toggle"]:::frontend
      end
    end
  end

  %% Application Layer (Backend)
  subgraph "Application Layer (Backend)"
    BE_Server["Express Server (Entry Point)"]:::backend
    subgraph "Controllers"
      BE_HomeworkController["Homework Controller"]:::backend
      BE_NotificationController["Notification Controller"]:::backend
      BE_SessionController["Session Controller"]:::backend
      BE_UserController["User Controller"]:::backend
    end
    subgraph "Routes"
      BE_HomeworkRoutes["homeworkRoutes.js"]:::backend
      BE_NotificationRoutes["notificationRoutes.js"]:::backend
      BE_SessionRoutes["sessionRoutes.js"]:::backend
      BE_UserRoutes["userRoutes.js"]:::backend
    end
    subgraph "Middleware"
      BE_AuthMiddleware["authMiddleware.js"]:::backend
      BE_ErrorMiddleware["errorMiddleware.js"]:::backend
    end
    subgraph "Models"
      BE_HomeworkModel["Homework.js"]:::backend
      BE_NotificationModel["Notification.js"]:::backend
      BE_SessionModel["Session.js"]:::backend
      BE_SessionDetailModel["SessionDetail.js"]:::backend
      BE_UserModel["User.js"]:::backend
    end
    BE_DBConfig["Database Config"]:::backend
  end

  %% Data Layer
  DB_Node["MongoDB Atlas"]:::database

  %% External Services
  subgraph "External Services"
    EXT_Axios["Axios"]:::external
    EXT_JWT["JWT & bcrypt"]:::external
    EXT_Vercel["Vercel (Frontend)"]:::external
    EXT_Render["Render (Backend)"]:::external
  end

  %% Connections from User to Frontend
  User -->|"navigates"| FE_App

  %% Frontend API calls via Axios
  FE_App -->|"HTTP(Axios)"| BE_Server
  FE_LoginPage -->|"HTTP(Axios)"| BE_Server
  FE_SignupPage -->|"HTTP(Axios)"| BE_Server
  FE_SessionsPage -->|"HTTP(Axios)"| BE_Server
  FE_HomeworkPage -->|"HTTP(Axios)"| BE_Server

  %% Connection from Frontend to Axios dependency
  FE_App ---|"uses"| EXT_Axios

  %% Deployment connections
  EXT_Vercel ---|"deploys"| FE_App
  EXT_Render ---|"deploys"| BE_Server

  %% Backend internal flow
  BE_Server -->|"routes"| BE_HomeworkRoutes
  BE_Server -->|"routes"| BE_NotificationRoutes
  BE_Server -->|"routes"| BE_SessionRoutes
  BE_Server -->|"routes"| BE_UserRoutes

  %% Routes invoke middleware
  BE_HomeworkRoutes -->|"secure"| BE_AuthMiddleware
  BE_NotificationRoutes -->|"secure"| BE_AuthMiddleware
  BE_SessionRoutes -->|"secure"| BE_AuthMiddleware
  BE_UserRoutes -->|"secure"| BE_AuthMiddleware

  %% Middleware forwards to controllers
  BE_AuthMiddleware --> BE_HomeworkController
  BE_AuthMiddleware --> BE_NotificationController
  BE_AuthMiddleware --> BE_SessionController
  BE_AuthMiddleware --> BE_UserController

  %% Controllers perform operations via Models
  BE_HomeworkController --> BE_HomeworkModel
  BE_NotificationController --> BE_NotificationModel
  BE_SessionController --> BE_SessionModel
  BE_SessionController --> BE_SessionDetailModel
  BE_UserController --> BE_UserModel

  %% Models interact with Database
  BE_HomeworkModel --> DB_Node
  BE_NotificationModel --> DB_Node
  BE_SessionModel --> DB_Node
  BE_SessionDetailModel --> DB_Node
  BE_UserModel --> DB_Node

  %% Database configuration
  BE_DBConfig --> DB_Node

  %% Security connections from Controllers to JWT & bcrypt
  BE_HomeworkController ---|"auth"| EXT_JWT
  BE_NotificationController ---|"auth"| EXT_JWT
  BE_SessionController ---|"auth"| EXT_JWT
  BE_UserController ---|"auth"| EXT_JWT

  %% Click Events for Frontend Components
  click FE_App "https://github.com/iamaniket10/session-tracker-portal/tree/main/frontend/src/app"
  click FE_LoginPage "https://github.com/iamaniket10/session-tracker-portal/blob/main/frontend/src/app/login/page.tsx"
  click FE_SignupPage "https://github.com/iamaniket10/session-tracker-portal/blob/main/frontend/src/app/signup/page.tsx"
  click FE_LoginForm "https://github.com/iamaniket10/session-tracker-portal/blob/main/frontend/src/components/login-form.tsx"
  click FE_SignupForm "https://github.com/iamaniket10/session-tracker-portal/blob/main/frontend/src/components/signup-form.tsx"
  click FE_SessionsPage "https://github.com/iamaniket10/session-tracker-portal/blob/main/frontend/src/app/sessions/[id]/page.tsx"
  click FE_SessionAccordion "https://github.com/iamaniket10/session-tracker-portal/blob/main/frontend/src/components/sessions/session-accordion.tsx"
  click FE_SessionDetail "https://github.com/iamaniket10/session-tracker-portal/blob/main/frontend/src/components/sessions/session-details.tsx"
  click FE_SessionOverview "https://github.com/iamaniket10/session-tracker-portal/blob/main/frontend/src/components/sessions/session-overview.tsx"
  click FE_EditableCell "https://github.com/iamaniket10/session-tracker-portal/blob/main/frontend/src/components/sessions/editable-cell.tsx"
  click FE_HomeworkPage "https://github.com/iamaniket10/session-tracker-portal/tree/main/frontend/src/app/homework"
  click FE_HomeworkManagement "https://github.com/iamaniket10/session-tracker-portal/tree/main/frontend/src/components/homework"
  click FE_UI "https://github.com/iamaniket10/session-tracker-portal/tree/main/frontend/src/components/ui"
  click FE_Globals "https://github.com/iamaniket10/session-tracker-portal/blob/main/frontend/src/app/globals.css"
  click FE_ThemeProvider "https://github.com/iamaniket10/session-tracker-portal/blob/main/frontend/src/components/theme-provider.tsx"
  click FE_ThemeToggle "https://github.com/iamaniket10/session-tracker-portal/blob/main/frontend/src/components/theme-toggle.tsx"

  %% Click Events for Backend Components
  click BE_Server "https://github.com/iamaniket10/session-tracker-portal/blob/main/backend/server.js"
  click BE_HomeworkController "https://github.com/iamaniket10/session-tracker-portal/blob/main/backend/controllers/homeworkController.js"
  click BE_NotificationController "https://github.com/iamaniket10/session-tracker-portal/blob/main/backend/controllers/notificationController.js"
  click BE_SessionController "https://github.com/iamaniket10/session-tracker-portal/blob/main/backend/controllers/sessionController.js"
  click BE_UserController "https://github.com/iamaniket10/session-tracker-portal/blob/main/backend/controllers/userController.js"
  click BE_HomeworkModel "https://github.com/iamaniket10/session-tracker-portal/blob/main/backend/models/Homework.js"
  click BE_NotificationModel "https://github.com/iamaniket10/session-tracker-portal/blob/main/backend/models/Notification.js"
  click BE_SessionModel "https://github.com/iamaniket10/session-tracker-portal/blob/main/backend/models/Session.js"
  click BE_SessionDetailModel "https://github.com/iamaniket10/session-tracker-portal/blob/main/backend/models/SessionDetail.js"
  click BE_UserModel "https://github.com/iamaniket10/session-tracker-portal/blob/main/backend/models/User.js"
  click BE_HomeworkRoutes "https://github.com/iamaniket10/session-tracker-portal/blob/main/backend/routes/homeworkRoutes.js"
  click BE_NotificationRoutes "https://github.com/iamaniket10/session-tracker-portal/blob/main/backend/routes/notificationRoutes.js"
  click BE_SessionRoutes "https://github.com/iamaniket10/session-tracker-portal/blob/main/backend/routes/sessionRoutes.js"
  click BE_UserRoutes "https://github.com/iamaniket10/session-tracker-portal/blob/main/backend/routes/userRoutes.js"
  click BE_AuthMiddleware "https://github.com/iamaniket10/session-tracker-portal/blob/main/backend/middleware/authMiddleware.js"
  click BE_ErrorMiddleware "https://github.com/iamaniket10/session-tracker-portal/blob/main/backend/middleware/errorMiddleware.js"
  click BE_DBConfig "https://github.com/iamaniket10/session-tracker-portal/blob/main/backend/config/database.js"

  %% Style classes
  classDef frontend fill:#AED6F1,stroke:#1F618D,stroke-width:2px;
  classDef backend fill:#F9E79F,stroke:#B9770E,stroke-width:2px;
  classDef database fill:#D5F5E3,stroke:#28B463,stroke-width:2px;
  classDef external fill:#F5B7B1,stroke:#C0392B,stroke-width:2px;
```
