# kp-singh09/minor-project architecture

> Architecture diagram of the GitHub repository kp-singh09/minor-project, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-11-14). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/kp-singh09/minor-project
- Repository: https://github.com/kp-singh09/minor-project

## Overview

##### Project Type and Purpose
- Full-stack MERN (MongoDB, Express, React, Node.js) quiz-builder application
- Key features: dynamic form creation, interactive renderers, user authentication (Clerk), image hosting (ImageKit), analytics

##### File Structure
- Top-level:
– client/ → React + Vite frontend
– server/ → Express + Node.js backend
– package.json files, .gitignore, README.md
- client/src/ → UI components, pages, builder & renderer modules, layouts, themes, templates
- server/controllers, server/routes, server/models → MVC pattern
- External config: Clerk, ImageKit, .env files, tailwind.config.js, Vite & ESLint configs

##### README for Technical Stack & Data Flow
- Frontend stack: React, Tailwind, Framer Motion, Axios
- Backend stack: Express, Mongoose, MongoDB
- Auth: Clerk service
- Image uploads: ImageKit (via dedicated controller/routes)
- CORS between client (5173) and server (5000)

##### Main Components
a. Frontend (Browser):
– React App (App.jsx, main.jsx)
– Pages: Dashboard, FormCreator, FormRenderer, Results, Stats, Auth (SignIn, SignUp)
– Builder modules (components/builder/*) and Renderer modules (components/renderer/*)
– Axios HTTP client for API calls
b. Backend (Server):
– Express app (server/index.js)
– Routes layer (aiRoutes, formRoutes, responseRoutes, statsRoutes, imageKitRoutes)
– Controllers (aiController, formController, responseController, statsController, imageKitController)
– Models (Form, Question, Response) via Mongoose
c. Database:
– MongoDB Atlas (collections: forms, questions, responses, stats)
d. External Services:
– Clerk (authentication)
– ImageKit (image storage & CDN)
– (Possibly AI API behind aiController)

##### Relationships & Data Flow
- User → Browser → React UI
- UI → Axios → Express API (over HTTP, with CORS)
- Express Routes → Controllers → Mongoose Models → MongoDB
- Controllers → External services (Clerk for tokens, ImageKit for uploads, AI API for prompts)
- Server → returns JSON → UI updates state

##### Architectural Patterns & Design Principles
- MVC on the backend: separated models, controllers, and routes
- Component-based UI: builder vs. renderer modules
- API layer decoupling: client never talks directly to DB
- Single responsibility: each route & controller handles one concern
- Environmental configuration: .env in client & server for keys and URLs

1. Frontend (blue)
2. API Layer / Backend (green)
3. Database (orange)
4. External Services (purple)
b. Within each zone, list major subcomponents:
– Frontend: Pages, Builder Components, Renderer Components, Axios Client
– Backend: Express App, Routes, Controllers, Models
– Database: MongoDB Atlas
– External: Clerk, ImageKit, AI Service
– User interactions → Frontend
– Frontend → Backend (API calls)
– Backend → Database (reads/writes)
– Backend → External Services (auth, image, AI)

## Diagram (Mermaid)

```mermaid
graph TB
    %% Legend
    classDef frontend fill:#D6EFFF,stroke:#0366d6,color:#0366d6
    classDef backend fill:#DFFFE0,stroke:#228B22,color:#228B22
    classDef db fill:#FFE5B4,stroke:#FFA500,color:#A0522D
    classDef external fill:#E8D5FF,stroke:#800080,color:#800080
    classDef user fill:#FFFFFF,stroke:#000000,color:#000000

    %% User
    User["User"]:::user

    %% Frontend Zone
    subgraph "Frontend (React)" 
        direction TB
        ReactApp["React App"]:::frontend
        MainEntry["main.jsx"]:::frontend
        AppEntry["App.jsx"]:::frontend
        subgraph "Pages"
            Dashboard["DashboardPage.jsx"]:::frontend
            Creator["FormCreatorPage.jsx"]:::frontend
            RendererPage["FormRenderer.jsx"]:::frontend
            Results["ResultsPage.jsx"]:::frontend
            Stats["StatsPage.jsx"]:::frontend
            SignIn["SignInPage.jsx"]:::frontend
            SignUp["SignUpPage.jsx"]:::frontend
            ResponsesList["ResponsesListPage.jsx"]:::frontend
            ResponseViewer["ResponseViewerPage.jsx"]:::frontend
            Submissions["SubmissionsPage.jsx"]:::frontend
        end
        subgraph "Builder Components"
            BuilderDir["builder/*.jsx"]:::frontend
        end
        subgraph "Renderer Components"
            RendererDir["renderer/*.jsx"]:::frontend
        end
        subgraph "Layouts"
            EditorLayout["EditorLayout.jsx"]:::frontend
            PublicLayout["PublicLayout.jsx"]:::frontend
            ProtectedLayout["ProtectedLayout.jsx"]:::frontend
        end
        AxiosClient["Axios HTTP Client"]:::frontend
    end

    %% Backend Zone
    subgraph "Backend API (Express)" 
        direction TB
        ExpressApp["Express App\n(server/index.js)"]:::backend
        subgraph "Routes"
            AIRoutes["aiRoutes.js"]:::backend
            FormRoutes["formRoutes.js"]:::backend
            ResponseRoutes["responseRoutes.js"]:::backend
            StatsRoutes["statsRoutes.js"]:::backend
            ImageKitRoutes["imageKitRoutes.js"]:::backend
        end
        subgraph "Controllers"
            AIController["aiController.js"]:::backend
            FormController["formController.js"]:::backend
            ResponseController["responseController.js"]:::backend
            StatsController["statsController.js"]:::backend
            ImageKitController["imageKitController.js"]:::backend
        end
        subgraph "Models"
            FormModel["Form.js"]:::backend
            QuestionModel["Question.js"]:::backend
            ResponseModel["Response.js"]:::backend
        end
    end

    %% Database Zone
    subgraph "Database (MongoDB Atlas)" 
        MongoDB["MongoDB Atlas\n(forms, questions, responses, stats)"]:::db
    end

    %% External Services Zone
    subgraph "External Services" 
        Clerk["Clerk Auth"]:::external
        ImageKit["ImageKit CDN"]:::external
        AIService["AI API Service"]:::external
    end

    %% Connections
    User -->|"interacts with"| ReactApp
    ReactApp --> MainEntry
    ReactApp --> AppEntry
    ReactApp --> Pages
    ReactApp --> BuilderDir
    ReactApp --> RendererDir
    ReactApp --> EditorLayout
    ReactApp --> PublicLayout
    ReactApp --> ProtectedLayout
    ReactApp --> AxiosClient

    AxiosClient -->|"HTTP/JSON"| ExpressApp
    ExpressApp --> AIRoutes
    ExpressApp --> FormRoutes
    ExpressApp --> ResponseRoutes
    ExpressApp --> StatsRoutes
    ExpressApp --> ImageKitRoutes

    AIRoutes --> AIController
    FormRoutes --> FormController
    ResponseRoutes --> ResponseController
    StatsRoutes --> StatsController
    ImageKitRoutes --> ImageKitController

    AIController -->|reads/writes| MongoDB
    FormController --> MongoDB
    ResponseController --> MongoDB
    StatsController --> MongoDB
    ImageKitController --> MongoDB

    AIController -->|fetch| AIService
    ExpressApp -->|verify token| Clerk
    ImageKitController -->|upload| ImageKit

    %% Click Events
    click MainEntry "https://github.com/kp-singh09/minor-project/blob/main/client/src/main.jsx"
    click AppEntry "https://github.com/kp-singh09/minor-project/blob/main/client/src/App.jsx"
    click Dashboard "https://github.com/kp-singh09/minor-project/blob/main/client/src/pages/DashboardPage.jsx"
    click Creator "https://github.com/kp-singh09/minor-project/blob/main/client/src/pages/FormCreatorPage.jsx"
    click RendererPage "https://github.com/kp-singh09/minor-project/blob/main/client/src/pages/FormRenderer.jsx"
    click Results "https://github.com/kp-singh09/minor-project/blob/main/client/src/pages/ResultsPage.jsx"
    click Stats "https://github.com/kp-singh09/minor-project/blob/main/client/src/pages/StatsPage.jsx"
    click SignIn "https://github.com/kp-singh09/minor-project/blob/main/client/src/pages/SignInPage.jsx"
    click SignUp "https://github.com/kp-singh09/minor-project/blob/main/client/src/pages/SignUpPage.jsx"
    click ResponsesList "https://github.com/kp-singh09/minor-project/blob/main/client/src/pages/ResponsesListPage.jsx"
    click ResponseViewer "https://github.com/kp-singh09/minor-project/blob/main/client/src/pages/ResponseViewerPage.jsx"
    click Submissions "https://github.com/kp-singh09/minor-project/blob/main/client/src/pages/SubmissionsPage.jsx"
    click BuilderDir "https://github.com/kp-singh09/minor-project/tree/main/client/src/components/builder"
    click RendererDir "https://github.com/kp-singh09/minor-project/tree/main/client/src/components/renderer"
    click EditorLayout "https://github.com/kp-singh09/minor-project/blob/main/client/src/layouts/EditorLayout.jsx"
    click PublicLayout "https://github.com/kp-singh09/minor-project/blob/main/client/src/pages/PublicLayout.jsx"
    click ProtectedLayout "https://github.com/kp-singh09/minor-project/blob/main/client/src/pages/ProtectedLayout.jsx"
    click ExpressApp "https://github.com/kp-singh09/minor-project/blob/main/server/index.js"
    click AIRoutes "https://github.com/kp-singh09/minor-project/blob/main/server/routes/aiRoutes.js"
    click FormRoutes "https://github.com/kp-singh09/minor-project/blob/main/server/routes/formRoutes.js"
    click ResponseRoutes "https://github.com/kp-singh09/minor-project/blob/main/server/routes/responseRoutes.js"
    click StatsRoutes "https://github.com/kp-singh09/minor-project/blob/main/server/routes/statsRoutes.js"
    click ImageKitRoutes "https://github.com/kp-singh09/minor-project/blob/main/server/routes/imageKitRoutes.js"
    click AIController "https://github.com/kp-singh09/minor-project/blob/main/server/controllers/aiController.js"
    click FormController "https://github.com/kp-singh09/minor-project/blob/main/server/controllers/formController.js"
    click ResponseController "https://github.com/kp-singh09/minor-project/blob/main/server/controllers/responseController.js"
    click StatsController "https://github.com/kp-singh09/minor-project/blob/main/server/controllers/statsController.js"
    click ImageKitController "https://github.com/kp-singh09/minor-project/blob/main/server/controllers/imageKitController.js"
    click FormModel "https://github.com/kp-singh09/minor-project/blob/main/server/models/Form.js"
    click QuestionModel "https://github.com/kp-singh09/minor-project/blob/main/server/models/Question.js"
    click ResponseModel "https://github.com/kp-singh09/minor-project/blob/main/server/models/Response.js"

    %% Classes
    class ReactApp,MainEntry,AppEntry,Dashboard,Creator,RendererPage,Results,Stats,SignIn,SignUp,ResponsesList,ResponseViewer,Submissions,BuilderDir,RendererDir,EditorLayout,PublicLayout,ProtectedLayout,AxiosClient frontend
    class ExpressApp,AIRoutes,FormRoutes,ResponseRoutes,StatsRoutes,ImageKitRoutes,AIController,FormController,ResponseController,StatsController,ImageKitController,FormModel,QuestionModel,ResponseModel backend
    class MongoDB db
    class Clerk,ImageKit,AIService external
```
