# ins-vj/amber architecture

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

- Interactive diagram: https://gitdiagram.com/ins-vj/amber
- Repository: https://github.com/ins-vj/amber

## Overview

##### Project type and purpose
- Full-stack e-learning platform (“Amber”) combining a Next.js/TypeScript frontend with an Express.js backend.
- Purpose: allow users to upload, manage, and stream video lessons (M3U8) with adaptive quality, backed by cloud storage and a managed database.

##### File structure
A. Top-level “backend” directory
– src/controllers, src/routes, src/middlewares → Express MVC pattern
– prisma/ → Prisma ORM migrations & schema for Neon DB
– utils/ → shared helpers (ApiError, ApiResponse, asyncHandler, token, cloudinary)
– seed.js → initial DB data
B. “experimental” directory (sandbox proof-of-concept)
– experimental/backend → standalone Express demo for Cloudinary + Neon
– experimental/frontend → simple React demo with VideoUploader/VideoPlayer components
C. No production “frontend” folder is present in the tree, but README indicates a Next.js 14 TypeScript project under frontend/.

##### README for additional insights
- Frontend: Next.js 14 + TypeScript + Spline for 3D UI
- Backend: Express.js, Cloudinary for video storage/streaming, Neon for metadata
- Authentication via JWT (in middlewares)
- Streaming served via Cloudinary M3U8 endpoints, quality switching handled client-side

##### Elements
– Clear component labels (e.g., “Next.js App”, “Express API”, “Prisma Client”, “Cloudinary Storage”, “Neon DB”)
- Frontend: blue rectangle
- Backend/API: green rectangle
– Annotations for protocols (HTTP-REST, JWT auth headers, M3U8 HLS streaming) and ports (e.g., 3000, 8080)

## Diagram (Mermaid)

```mermaid
flowchart TB
    subgraph "Frontend Layer"
        NextJS["Next.js App (3000)"]:::frontend
        NextJS -->|HTTP REST| ExpressAPI
        NextJS -->|HLS/M3U8 Streams| CDN
    end

    subgraph "Backend/API Layer"
        ExpressAPI["Express API"]:::backend
        AppConfig["Express App Config"]:::backend
        ExpressAPI -->|config| AppConfig

        subgraph "Express MVC"
            subgraph "Controllers"
                UserCtrl["User Controller"]:::backend
                CourseCtrl["Course Controller"]:::backend
                InstructorCtrl["Instructor Controller"]:::backend
                VideoCtrl["Video Controller"]:::backend
            end
            subgraph "Routes"
                UserRoutes["User Routes"]:::backend
                CourseRoutes["Course Routes"]:::backend
                InstructorRoutes["Instructor Routes"]:::backend
            end
            subgraph "Middleware"
                AuthUser["Auth User Middleware"]:::backend
                AuthInstructor["Auth Instructor Middleware"]:::backend
                Multer["File Upload Middleware"]:::backend
            end
            Controllers --> Routes
            Routes --> ExpressAPI
            ExpressAPI --> Controllers
        end

        subgraph "Utils"
            TokenUtil["JWT Token Utility"]:::backend
            CloudinaryUtil["Cloudinary Utility"]:::backend
            AsyncUtil["Async Error Handler"]:::backend
            ApiResponse["API Response Utility"]:::backend
            ApiError["API Error Utility"]:::backend
        end

        ExpressAPI -->|uses| TokenUtil
        ExpressAPI -->|uses| CloudinaryUtil
        ExpressAPI -->|uses| AsyncUtil
        ExpressAPI -->|uses| ApiResponse
        ExpressAPI -->|uses| ApiError
        ExpressAPI -->|CRUD| PrismaClient
        ExpressAPI -->|Upload/Stream| Cloudinary
    end

    PrismaClient["Prisma Client"]:::database
    PrismaClient -->|connect| NeonDB

    NeonDB["Neon DB (PostgreSQL)"]:::database
    Cloudinary["Cloudinary Service"]:::cloud
    CDN["Cloudinary CDN (HLS)"]:::cloud

    CDN --> NextJS

    subgraph "Experimental POC"
        ExpBackend["Experimental Backend Server"]:::experimental
        ExpBackendUploadRoute["Experimental Upload Route"]:::experimental
        ExpCloudConfig["Experimental Cloudinary Config"]:::experimental
        ExpMulterConfig["Experimental Multer Config"]:::experimental
        ExpNeonClient["Experimental Neon Client"]:::experimental
        ExpUploadMw["Experimental Upload Middleware"]:::experimental
        ExpBackend --> ExpBackendUploadRoute
        ExpBackend --> ExpCloudConfig
        ExpBackend --> ExpMulterConfig
        ExpBackend --> ExpNeonClient
        ExpBackendUploadRoute --> ExpUploadMw

        ExpFrontend["Experimental Frontend"]:::experimental
        ExpVidUploader["Video Uploader Component"]:::experimental
        ExpVidPlayer["Video Player Component"]:::experimental
        ExpFrontend --> ExpVidUploader
        ExpFrontend --> ExpVidPlayer
    end

    click ExpressAPI "https://github.com/ins-vj/amber/blob/main/backend/src/server.js"
    click AppConfig "https://github.com/ins-vj/amber/blob/main/backend/src/app.js"
    click UserCtrl "https://github.com/ins-vj/amber/blob/main/backend/src/controllers/user.controller.js"
    click CourseCtrl "https://github.com/ins-vj/amber/blob/main/backend/src/controllers/course.controller.js"
    click InstructorCtrl "https://github.com/ins-vj/amber/blob/main/backend/src/controllers/instructor.controller.js"
    click VideoCtrl "https://github.com/ins-vj/amber/blob/main/backend/src/controllers/xys.js"
    click UserRoutes "https://github.com/ins-vj/amber/blob/main/backend/src/routes/user.routes.js"
    click CourseRoutes "https://github.com/ins-vj/amber/blob/main/backend/src/routes/course.routes.js"
    click InstructorRoutes "https://github.com/ins-vj/amber/blob/main/backend/src/routes/instructor.routes.js"
    click AuthUser "https://github.com/ins-vj/amber/blob/main/backend/src/middlewares/auth.usermiddleware.js"
    click AuthInstructor "https://github.com/ins-vj/amber/blob/main/backend/src/middlewares/auth.insmiddleware.js"
    click Multer "https://github.com/ins-vj/amber/blob/main/backend/src/middlewares/multer.middleware.js"
    click PrismaClient "https://github.com/ins-vj/amber/blob/main/backend/prisma/schema.prisma"
    click NeonDB "https://github.com/ins-vj/amber/tree/main/backend/prisma/migrations/"
    click SeedScript "https://github.com/ins-vj/amber/blob/main/backend/prisma/seed.js"
    click CloudinaryUtil "https://github.com/ins-vj/amber/blob/main/backend/src/utils/cloudinary.js"
    click TokenUtil "https://github.com/ins-vj/amber/blob/main/backend/src/utils/token.js"
    click AsyncUtil "https://github.com/ins-vj/amber/blob/main/backend/src/utils/asyncHandler.js"
    click ApiResponse "https://github.com/ins-vj/amber/blob/main/backend/src/utils/ApiResponse.js"
    click ApiError "https://github.com/ins-vj/amber/blob/main/backend/src/utils/ApiError.js"
    click ExpBackend "https://github.com/ins-vj/amber/blob/main/experimental/backend/server.js"
    click ExpBackendUploadRoute "https://github.com/ins-vj/amber/blob/main/experimental/backend/api/uploadRoute.js"
    click ExpCloudConfig "https://github.com/ins-vj/amber/blob/main/experimental/backend/config/cloudinaryConfig.js"
    click ExpMulterConfig "https://github.com/ins-vj/amber/blob/main/experimental/backend/config/multerConfig.js"
    click ExpNeonClient "https://github.com/ins-vj/amber/blob/main/experimental/backend/db/neonClient.js"
    click ExpUploadMw "https://github.com/ins-vj/amber/blob/main/experimental/backend/middleware/upload.js"
    click ExpVidUploader "https://github.com/ins-vj/amber/blob/main/experimental/frontend/src/components/VideoUploader.js"
    click ExpVidPlayer "https://github.com/ins-vj/amber/blob/main/experimental/frontend/src/components/VideoPlayer.js"
    click ExpFrontend "https://github.com/ins-vj/amber/blob/main/experimental/frontend/src/App.js"

    classDef frontend fill:#ADD8E6,stroke:#000
    classDef backend fill:#90EE90,stroke:#000
    classDef database fill:#FFA500,stroke:#000
    classDef cloud fill:#DDA0DD,stroke:#000
    classDef experimental fill:#D3D3D3,stroke:#000
```
