# satyam-chaudhary/alma-mater architecture

> Architecture diagram of the GitHub repository satyam-chaudhary/alma-mater, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-29). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/satyam-chaudhary/alma-mater
- Repository: https://github.com/satyam-chaudhary/alma-mater

## Overview

##### Project Type and Purpose
- This is a full-stack Next.js web application (bootstrapped with create-next-app) that allows users to search for colleges, view details (events, research, network, jobs), and includes protected form routes for administrators to add events, network posts, and research entries.
- The app uses React for UI, Next.js App Router for routing and server-side rendering (SSR/ISR), Prisma as an ORM for database access, and Tailwind CSS for styling.

##### File Structure Analysis
- Top-level files:
- next.config.mjs, tsconfig.json, tailwind.config.ts, postcss.config.mjs: Build and configuration.
- prisma/schema.prisma: Database schema.
- Directories:
- src/app: Next.js App Router – pages (page.tsx), layout.tsx, loading.tsx, global CSS, and server/API route handlers under app/api.
- src/components & src/app/components: React UI components.
- src/db: Prisma client initialization and DB utilities.
- src/lib: Seed scripts and utility functions.
- util: Static data (collegeData.json).
- API routes under src/app/api/* implement REST endpoints for home, search, events, job details, network, research, and collegeDetails.
- Protected routes under src/app/protected/* for admin forms.
- Middleware (middleware.ts) for route protection and redirects.

##### Key Architectural Patterns
- Separation of concerns:
- Presentation (React components under src/app and src/components)
- Data access (Prisma client in src/db)
- API layer (Next.js Route Handlers under app/api)
- Next.js App Router for file-based routing, SSR/ISR.
- MVC-like flow within API routes: Route Handler → Data access via Prisma or util → Response.
- Protected route middleware to enforce authentication/authorization.
- Utility scripts (seed, helpers) separate from runtime code.

##### Main Components & Their Interactions
a. Client Browser (User’s browser)
↔ HTTP(s)
b. Next.js Server (hosted on Vercel or Node.js)
- Frontend (React pages in src/app/*)
- API Route Handlers (src/app/api/*)
- Middleware (middleware.ts)
c. Database
- PostgreSQL/Mysql (configured in prisma/schema.prisma), accessed via Prisma Client (src/db/prisma.ts)
d. Utilities & Seed Scripts (local, run offline)
- src/lib/seed.ts, util/collegeData.ts
e. External Services
- Google Fonts (served via next/font)
- (Optional) Vercel platform for deployment

Data Flow:
1. User requests a page (e.g., /collegeDetails/Stanford) → Next.js routing → React page component (SSR or SSG).
2. Page server component may call fetch to internal API routes (e.g., /api/collegeDetails/Stanford) or directly use Prisma in server components.
3. API route handler executes business logic, uses Prisma to query DB or util JSON, returns JSON.
4. Frontend renders data; client-side interactivity may fetch more data via API endpoints.
5. Protected routes invoke middleware to check session/auth, then render admin forms.

## Diagram (Mermaid)

```mermaid
flowchart TD
  classDef client fill:#D0E8FF,stroke:#3182CE,color:#1A365D
  classDef server fill:#DFFFE0,stroke:#2F855A,color:#22543D
  classDef frontend fill:#E0F7FA,stroke:#00ACC1,color:#004D40
  classDef api fill:#E6FFFA,stroke:#38A169,color:#2F855A
  classDef data fill:#FFF0B3,stroke:#D69E2E,color:#975A16
  classDef util fill:#F0F0F0,stroke:#A0AEC0,color:#4A5568
  classDef external fill:#F0FFF4,stroke:#68D391,color:#276749

  subgraph "Client Layer"
    Browser["User Browser"]:::client
  end

  subgraph "Application Layer"
    subgraph "Next.js Server"
      Router["Next.js App Router"]:::server
      Middleware["Route Protection Middleware"]:::server

      subgraph "Page Layer"
        HomePage["Home Page Component"]:::frontend
        AboutPage["About Us Page Component"]:::frontend
        CollegeDetailsPage["College Details Page Component"]:::frontend
        JobLandingPage["Job Landing Page Component"]:::frontend
        FallbackPage["Catch-all Handler"]:::frontend
        GlobalLayout["Global Layout"]:::frontend
        LoadingComponent["Loading State Component"]:::frontend
        GlobalsCss["Global Stylesheet"]:::frontend
      end

      subgraph "UI Components"
        AboutComp["About.tsx"]:::frontend
        CollegeCards["CollegeCards.tsx"]:::frontend
        CollegesHome["CollegesHome.tsx"]:::frontend
        EventsComp["Events.tsx"]:::frontend
        NetworkHub["NetworkHub.tsx"]:::frontend
        ResearchCollege["ResearchCollege.tsx"]:::frontend
        SearchBar["SearchBar.tsx"]:::frontend
        SearchResults["SearchResults.tsx"]:::frontend
        Footer["Footer.tsx"]:::frontend
        Nav["Nav.tsx"]:::frontend
        NavBarCollegeDetails["NavBarCollegeDetails.tsx"]:::frontend
        CollegeDetailsComp["CollegeDetailsComponent.tsx"]:::frontend
      end

      subgraph "API Layer"
        ApiHome["API Route: /api/home"]:::api
        ApiSearch["API Route: /api/search"]:::api
        ApiEvents["API Route: /api/events"]:::api
        ApiEventsByCollege["API Route: /api/eventsApi/[collegeId]"]:::api
        ApiJobDetails["API Route: /api/JobDetails/[jobid]"]:::api
        ApiNetwork["API Route: /api/Network"]:::api
        ApiNetworkByCollege["API Route: /api/networkApi/[collegeId]"]:::api
        ApiResearch["API Route: /api/Research"]:::api
        ApiResearchById["API Route: /api/researchApi/[researchId]"]:::api
        ApiCollegeDetails["API Route: /api/collegeDetails/[name]"]:::api
      end

      subgraph "Protected Admin Routes"
        EventForm["Event Form"]:::server
        NetworkForm["Network Post Form"]:::server
        ResearchForm["Research Entry Form"]:::server
      end
    end
  end

  subgraph "Data Layer"
    PrismaClient["Prisma Client"]:::data
    Database[(Database)]:::data
  end

  subgraph "Utilities & Seed Scripts"
    SeedScript["Seed Script"]:::util
    LibUtils["General Utilities"]:::util
    StaticData["collegeData.json"]:::util
    CollegeDataUtil["collegeData.ts"]:::util
  end

  subgraph "External Services"
    GoogleFonts["Google Fonts CDN"]:::external
    Vercel["Vercel Hosting"]:::external
  end

  Browser -->|"HTTP Request"| Router
  Router --> Middleware
  Middleware --> Router
  Router -->|"renders"| HomePage
  Router -->|"renders"| AboutPage
  Router -->|"renders"| CollegeDetailsPage
  Router -->|"renders"| JobLandingPage
  Router -->|"renders"| FallbackPage
  Router -->|"uses"| GlobalLayout
  Router -->|"uses"| LoadingComponent
  Router -->|"loads"| GlobalsCss

  HomePage -->|"uses"| AboutComp
  HomePage -->|"uses"| CollegeCards
  HomePage -->|"uses"| SearchBar
  CollegeDetailsPage -->|"uses"| CollegeDetailsComp
  CollegeDetailsPage -->|"uses"| NavBarCollegeDetails
  CollegeDetailsPage -->|"uses"| EventsComp
  CollegeDetailsPage -->|"uses"| NetworkHub
  CollegeDetailsPage -->|"uses"| ResearchCollege

  HomePage -->|"fetches"| ApiHome
  SearchResults -->|"fetches"| ApiSearch
  EventsComp -->|"fetches"| ApiEventsByCollege
  NetworkHub -->|"fetches"| ApiNetworkByCollege
  ResearchCollege -->|"fetches"| ApiResearchById
  JobLandingPage -->|"fetches"| ApiJobDetails
  CollegeDetailsPage -->|"fetches"| ApiCollegeDetails

  ApiHome --> PrismaClient
  ApiSearch --> PrismaClient
  ApiEvents --> PrismaClient
  ApiEventsByCollege --> PrismaClient
  ApiJobDetails --> PrismaClient
  ApiNetwork --> PrismaClient
  ApiNetworkByCollege --> PrismaClient
  ApiResearch --> PrismaClient
  ApiResearchById --> PrismaClient
  ApiCollegeDetails --> PrismaClient

  PrismaClient --> Database

  EventForm --> Middleware
  NetworkForm --> Middleware
  ResearchForm --> Middleware

  SeedScript --> StaticData
  SeedScript --> PrismaClient
  CollegeDataUtil --> StaticData

  Router --> GoogleFonts
  Router --> Vercel

  click HomePage "https://github.com/satyam-chaudhary/alma-mater/blob/main/src/app/page.tsx"
  click AboutPage "https://github.com/satyam-chaudhary/alma-mater/blob/main/src/app/aboutUs/page.tsx"
  click CollegeDetailsPage "https://github.com/satyam-chaudhary/alma-mater/blob/main/src/app/collegeDetails/[CollegeHome]/page.tsx"
  click JobLandingPage "https://github.com/satyam-chaudhary/alma-mater/blob/main/src/app/jobLanding/page.tsx"
  click FallbackPage "https://github.com/satyam-chaudhary/alma-mater/blob/main/src/app/handler/[...stack]/page.tsx"
  click GlobalLayout "https://github.com/satyam-chaudhary/alma-mater/blob/main/src/app/layout.tsx"
  click LoadingComponent "https://github.com/satyam-chaudhary/alma-mater/blob/main/src/app/loading.tsx"
  click GlobalsCss "https://github.com/satyam-chaudhary/alma-mater/blob/main/src/app/globals.css"

  click AboutComp "https://github.com/satyam-chaudhary/alma-mater/blob/main/src/app/components/About.tsx"
  click CollegeCards "https://github.com/satyam-chaudhary/alma-mater/blob/main/src/app/components/CollegeCards.tsx"
  click CollegesHome "https://github.com/satyam-chaudhary/alma-mater/blob/main/src/app/components/CollegesHome.tsx"
  click EventsComp "https://github.com/satyam-chaudhary/alma-mater/blob/main/src/app/components/Events.tsx"
  click NetworkHub "https://github.com/satyam-chaudhary/alma-mater/blob/main/src/app/components/NetworkHub.tsx"
  click ResearchCollege "https://github.com/satyam-chaudhary/alma-mater/blob/main/src/app/components/ResearchCollege.tsx"
  click SearchBar "https://github.com/satyam-chaudhary/alma-mater/blob/main/src/app/components/SearchBar.tsx"
  click SearchResults "https://github.com/satyam-chaudhary/alma-mater/blob/main/src/app/components/SearchResults.tsx"
  click Footer "https://github.com/satyam-chaudhary/alma-mater/blob/main/src/app/components/Footer.tsx"
  click Nav "https://github.com/satyam-chaudhary/alma-mater/blob/main/src/app/components/Nav.tsx"
  click NavBarCollegeDetails "https://github.com/satyam-chaudhary/alma-mater/blob/main/src/app/components/NavBarCollegeDetails.tsx"
  click CollegeDetailsComp "https://github.com/satyam-chaudhary/alma-mater/blob/main/src/app/components/CollegeDetailsComponent.tsx"

  click ApiHome "https://github.com/satyam-chaudhary/alma-mater/blob/main/src/app/api/home/route.ts"
  click ApiSearch "https://github.com/satyam-chaudhary/alma-mater/blob/main/src/app/api/search/route.ts"
  click ApiEvents "https://github.com/satyam-chaudhary/alma-mater/blob/main/src/app/api/Events/route.ts"
  click ApiEventsByCollege "https://github.com/satyam-chaudhary/alma-mater/blob/main/src/app/api/eventsApi/[collegeId]/route.ts"
  click ApiJobDetails "https://github.com/satyam-chaudhary/alma-mater/blob/main/src/app/api/JobDetails/[jobid]/route.ts"
  click ApiNetwork "https://github.com/satyam-chaudhary/alma-mater/blob/main/src/app/api/Network/route.ts"
  click ApiNetworkByCollege "https://github.com/satyam-chaudhary/alma-mater/blob/main/src/app/api/networkApi/[collegeId]/route.ts"
  click ApiResearch "https://github.com/satyam-chaudhary/alma-mater/blob/main/src/app/api/Research/route.ts"
  click ApiResearchById "https://github.com/satyam-chaudhary/alma-mater/blob/main/src/app/api/researchApi/[researchId]/route.ts"
  click ApiCollegeDetails "https://github.com/satyam-chaudhary/alma-mater/blob/main/src/app/api/collegeDetails/[name]/route.ts"

  click EventForm "https://github.com/satyam-chaudhary/alma-mater/blob/main/src/app/protected/navFunctionForms/eventForm/page.tsx"
  click NetworkForm "https://github.com/satyam-chaudhary/alma-mater/blob/main/src/app/protected/navFunctionForms/networkForm/page.tsx"
  click ResearchForm "https://github.com/satyam-chaudhary/alma-mater/blob/main/src/app/protected/navFunctionForms/researchFrom/page.tsx"

  click PrismaClient "https://github.com/satyam-chaudhary/alma-mater/blob/main/src/db/prisma.ts"
  click Database "https://github.com/satyam-chaudhary/alma-mater/blob/main/prisma/schema.prisma"

  click SeedScript "https://github.com/satyam-chaudhary/alma-mater/blob/main/src/lib/seed.ts"
  click LibUtils "https://github.com/satyam-chaudhary/alma-mater/blob/main/src/lib/utils.ts"
  click StaticData "https://github.com/satyam-chaudhary/alma-mater/blob/main/util/collegeData.json"
  click CollegeDataUtil "https://github.com/satyam-chaudhary/alma-mater/blob/main/util/collegeData.ts"
  
  click Router "https://github.com/satyam-chaudhary/alma-mater/blob/main/next.config.mjs"
  click GlobalsCss "https://github.com/satyam-chaudhary/alma-mater/blob/main/tailwind.config.ts"
```
