# salmaimassenda2023/students-management architecture

> Architecture diagram of the GitHub repository salmaimassenda2023/students-management, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-07-25). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/salmaimassenda2023/students-management
- Repository: https://github.com/salmaimassenda2023/students-management

## Overview

##### Project type and purpose
- This is a full-stack web application built on Next.js (App Router), using Prisma for database access and Firebase for authentication & role management.
- Purpose: Provide user signup/signin, profile setup (admin vs. student), CRUD operations on student records, and an admin dashboard.

##### File structure
- “app/” directory: Next.js pages & server-side routes (App Router).
– app/page.js, app/layout.js, app/globals.css: top-level layout and styling.
– app/signin, app/signup, app/students_list, app/dashboard: UI routes (React Server Components or Client Components).
– app/api: serverless API routes under Next.js.
· admin-profile-setup, user-profile-setup, auth/[...nextauth], students/[id] & students: REST endpoints.
- “firebase/”: Firebase integration
– firebase-client.js: client SDK initialization
– firebase-admin.js: admin SDK for verifying tokens & setting custom claims
– setAdminRole.js: serverless function to grant admin roles
- “prisma/”: database schema & migrations
- “utils/”: shared helpers
– authOptions.js: NextAuth configuration
– middleware.js: route protection
– prisma.js: Prisma client instance
- Config files: next.config.mjs, jsconfig.json, postcss.config.mjs, firebase.json

##### README
- Confirms it’s a Next.js App Router project, bootstrapped with create-next-app.

a. Main components
1. Client Browser (React UI)
2. Next.js App (Server & Routing Layer)
3. Next.js API Routes (serverless functions)
4. Firebase Auth
5. Firebase Admin SDK (role management)
6. Prisma Client + Database (e.g. PostgreSQL/MySQL)
7. Hosting Platforms (Vercel for Next.js, Firebase for serverless functions)
b. Relationships & interactions
- The Client Browser loads React pages (signin, signup, dashboard, students_list) served by the Next.js App.
- UI calls Next.js API Routes (e.g., /api/auth → NextAuth on Firebase, /api/students → Prisma queries)
- API Routes use utils/middleware.js to enforce auth and authOptions.js to configure NextAuth with Firebase credentials.
- When a user signs up or signs in, NextAuth uses the Firebase Client SDK to register/authenticate.
- On protected endpoints, the Next.js layer calls Firebase Admin SDK to verify tokens and check custom claims for admin privileges.
- All database reads/writes for students and profiles go through Prisma Client to the underlying SQL database.
- setAdminRole.js can be triggered to assign “admin” claims in Firebase.
c. Architectural patterns & design principles
- Separation of concerns:
– UI (React Server/Client Components)
– Authentication (NextAuth + Firebase)
– Business logic & data access (API Routes + Prisma)
- Serverless Functions pattern via Next.js App Router’s route.js files.
- Middleware layer for authentication and authorization.
- Infrastructure as code: Prisma migrations, firebase.json.
d. Relevant technologies/frameworks
- Next.js App Router, React Server Components
- NextAuth.js (authOptions.js)
- Firebase JS SDK & Admin SDK
- Prisma ORM & SQL database
- Vercel (Next.js hosting) & Firebase Functions

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Presentation Layer
    subgraph "Presentation Layer"
        direction TB
        Browser["Client Browser"]:::frontend
        Pages["React UI Pages"]:::frontend
        Layout["Next.js Layout & Styles"]:::frontend
    end

    %% API Layer
    subgraph "API Layer"
        direction TB
        AuthRoute["API Route: /api/auth/[...nextauth]"]:::api
        AdminProfile["API Route: /api/admin-profile-setup"]:::api
        UserProfile["API Route: /api/user-profile-setup"]:::api
        Students["API Route: /api/students"]:::api
        StudentById["API Route: /api/students/[id]"]:::api
        AuthOptions["NextAuth Config (utils/authOptions.js)"]:::api
        Middleware["Authentication Middleware (utils/middleware.js)"]:::api
    end

    %% Auth Layer
    subgraph "Authentication Layer"
        direction TB
        FirebaseClient["Firebase Client SDK"]:::auth
        FirebaseAdmin["Firebase Admin SDK"]:::auth
        SetAdminRole["Serverless: setAdminRole.js"]:::auth
    end

    %% Data Layer
    subgraph "Data Layer"
        direction TB
        PrismaClient["Prisma Client (utils/prisma.js)"]:::db
        Database["SQL Database"]:::db
        Schema["Prisma Schema (prisma/schema.prisma)"]:::db
        Migrations["Prisma Migrations"]:::db
    end

    %% Config & Hosting
    subgraph "Config & Hosting"
        direction TB
        NextConfig["next.config.mjs"]:::config
        FirebaseConfig["firebase.json /.firebaserc"]:::config
        JSConfig["jsconfig.json"]:::config
        PostCSS["postcss.config.mjs"]:::config
    end

    %% Presentation interactions
    Browser -->|"loads"| Pages
    Pages -->|"uses layout/styles"| Layout
    Pages -->|"calls API"| AuthRoute
    Pages -->|"calls API"| AdminProfile
    Pages -->|"calls API"| UserProfile
    Pages -->|"calls API"| Students
    Pages -->|"calls API"| StudentById

    %% API internals
    AuthRoute -->|"imports"| AuthOptions
    AuthRoute -->|"uses"| FirebaseClient
    AdminProfile -->|"uses middleware"| Middleware
    AdminProfile -->|"verifies token via"| FirebaseAdmin
    UserProfile -->|"uses middleware"| Middleware
    UserProfile -->|"verifies token via"| FirebaseAdmin
    Students -->|"uses middleware"| Middleware
    Students -->|"access db via"| PrismaClient
    Students -->|"verifies token via"| FirebaseAdmin
    StudentById -->|"uses middleware"| Middleware
    StudentById -->|"access db via"| PrismaClient
    StudentById -->|"verifies token via"| FirebaseAdmin

    %% Auth control
    SetAdminRole -->|"uses"| FirebaseAdmin

    %% Data internals
    PrismaClient -->|"reads schema"| Schema
    PrismaClient -->|"executes migrations"| Migrations
    PrismaClient -->|"queries"| Database

    %% Config connections
    AuthRoute -->|"env vars"| NextConfig
    PrismaClient -->|"env vars"| NextConfig
    FirebaseClient -->|"config"| FirebaseConfig
    FirebaseAdmin -->|"config"| FirebaseConfig

    %% Click Events
    click Pages "https://github.com/salmaimassenda2023/students-management/blob/main/app/page.js"
    click Pages "https://github.com/salmaimassenda2023/students-management/blob/main/app/signup/page.js"
    click Pages "https://github.com/salmaimassenda2023/students-management/blob/main/app/signin/page.js"
    click Pages "https://github.com/salmaimassenda2023/students-management/blob/main/app/dashboard/page.js"
    click Pages "https://github.com/salmaimassenda2023/students-management/blob/main/app/students_list/page.js"
    click Layout "https://github.com/salmaimassenda2023/students-management/blob/main/app/layout.js"
    click Layout "https://github.com/salmaimassenda2023/students-management/blob/main/app/globals.css"
    click AuthRoute "https://github.com/salmaimassenda2023/students-management/blob/main/app/api/auth/[...nextauth]/route.js"
    click AdminProfile "https://github.com/salmaimassenda2023/students-management/blob/main/app/api/admin-profile-setup/route.js"
    click UserProfile "https://github.com/salmaimassenda2023/students-management/blob/main/app/api/user-profile-setup/route.js"
    click Students "https://github.com/salmaimassenda2023/students-management/blob/main/app/api/students/route.js"
    click StudentById "https://github.com/salmaimassenda2023/students-management/blob/main/app/api/students/[id]/route.js"
    click AuthOptions "https://github.com/salmaimassenda2023/students-management/blob/main/utils/authOptions.js"
    click Middleware "https://github.com/salmaimassenda2023/students-management/blob/main/utils/middleware.js"
    click FirebaseClient "https://github.com/salmaimassenda2023/students-management/blob/main/firebase/firebase-client.js"
    click FirebaseAdmin "https://github.com/salmaimassenda2023/students-management/blob/main/firebase/firebase-admin.js"
    click SetAdminRole "https://github.com/salmaimassenda2023/students-management/blob/main/firebase/setAdminRole.js"
    click PrismaClient "https://github.com/salmaimassenda2023/students-management/blob/main/utils/prisma.js"
    click Schema "https://github.com/salmaimassenda2023/students-management/blob/main/prisma/schema.prisma"
    click Migrations "https://github.com/salmaimassenda2023/students-management/blob/main/prisma/migrations/20250714223121_init/migration.sql"
    click Migrations "https://github.com/salmaimassenda2023/students-management/blob/main/prisma/migrations/20250715000044_your_migration_name/migration.sql"
    click Migrations "https://github.com/salmaimassenda2023/students-management/blob/main/prisma/migrations/migration_lock.toml"
    click NextConfig "https://github.com/salmaimassenda2023/students-management/blob/main/next.config.mjs"
    click FirebaseConfig "https://github.com/salmaimassenda2023/students-management/blob/main/firebase.json"
    click FirebaseConfig "https://github.com/salmaimassenda2023/students-management/blob/main/.firebaserc"
    click JSConfig "https://github.com/salmaimassenda2023/students-management/blob/main/jsconfig.json"
    click PostCSS "https://github.com/salmaimassenda2023/students-management/blob/main/postcss.config.mjs"

    %% Styles
    classDef frontend fill:#D0E8FF,stroke:#004A8F,color:#004A8F
    classDef api fill:#D5F5D5,stroke:#1F7A1F,color:#1F7A1F
    classDef auth fill:#FFD7A8,stroke:#C85A00,color:#C85A00
    classDef db fill:#E0E0E0,stroke:#555555,color:#555555
    classDef config fill:#F0E5FF,stroke:#6A0DAD,color:#6A0DAD
```
