# shreykoradia/peerlist-shrey architecture

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

- Interactive diagram: https://gitdiagram.com/shreykoradia/peerlist-shrey
- Repository: https://github.com/shreykoradia/peerlist-shrey

## Overview

##### Project type and purpose
- This is a full-stack, monorepo Next.js application that enables users to build, preview, publish, and fill out dynamic forms.
- It combines hybrid SSR/CSR front-end (form builder in CSR, published forms in SSR) with API routes in the same codebase and a MongoDB backend.

##### File structure
- Top-level files: next.config.js, Tailwind, ESLint, tsconfig, etc.
- src/app & src/pages: Next.js routing layer (app-directory for CSR/SSR pages, pages/api for serverless endpoints).
- src/modules: feature modules (form-builder, form-viewer, question-builder).
- src/shared: UI components, store (Zustand), and lib (MongoDB connection, constants).
- src/model & src/types: domain models and TypeScript types.

##### README for insights
- Uses Next.js for UI and API routes, Zustand for client state, MongoDB/Mongoose for persistence.
- Mix of SSR (published forms) and CSR (form creation).
- Core features: form creation CRUD, preview, publish, submission, and completion tracking.

##### Main components
A. Client (Browser) – Next.js front-end
- Form Builder UI (CSR)
– Modules: question-builder, form-builder components
– Zustand store (src/shared/store/form.ts)
– Tailwind UI library (src/shared/ui)
- Form Preview & Layout in “preview” mode (readonly CSR)
- Published Form Page (SSR on server, data fetched at request time)

B. Server (Next.js runtime)
- Next.js API Routes (src/pages/api/forms/*)
– Endpoints:
· GET/POST /api/forms → list/create forms
· GET/POST /api/forms/[id] → read or submit form responses
· POST /api/forms/publish → publish a form
– Business logic lives here or in src/modules/*/api.ts

- Data Access Layer
– MongoDB connection (src/shared/lib/mongoDb.ts)
– Mongoose schemas in src/model/form.model.ts

C. Database
- MongoDB cluster (external service)
- Collections: forms, responses

##### Relationships and data flows
1. User interacts with Form Builder UI → updates Zustand store.
2. On save/publish: front-end issues HTTP POST/PUT to Next.js API route.
3. API route calls Mongoose methods → persists form to MongoDB.
4. Publishing triggers SSR page generation for /form/[formId] route.
5. End users access published form → SSR GET /form/[formId] → fetch form data from DB → render HTML.
6. User submits answers → POST /api/forms/[id]/submit → write responses to DB → return status.
7. Front-end reads completion percentage either via CSR queries or SSR props.

##### Architectural patterns & design principles
- Layered architecture: Presentation (Next.js pages/components) → Application (API routes + feature modules) → Data (Mongoose + MongoDB).
- Module pattern: each feature (form-builder, form-viewer, question-builder) encapsulated under src/modules.
- Shared libraries (src/shared) enforce DRY for UI, state, and database glue.
- Hybrid rendering: CSR for builder and preview; SSR for published form pages.

##### Final checklist
- All major modules and layers represented.
- Data flows shown for create, preview, publish, and submit operations.
- Tech stack callouts (Next.js, Zustand, Mongoose, MongoDB, Tailwind).
- Hybrid rendering path (SSR vs CSR) is explicit.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Browser
    B["Browser"]:::external

    %% Frontend Layer
    subgraph "Frontend (Next.js CSR/SSR)"
        direction TB
        FBUI["Form Builder UI (CSR)"]:::frontend
        QB["Question Builder"]:::frontend
        FP["Form Preview (CSR Readonly)"]:::frontend
        PFP["Published Form Page (SSR)"]:::frontend
        ZS["Zustand Form Store"]:::shared
        SU["Shared UI Components"]:::shared
        NApp["Next.js App Directory"]:::shared
    end

    %% Server Layer
    subgraph "Server (Next.js API & Data Access)"
        direction TB
        APIIndex["GET/POST /api/forms"]:::server
        APIID["GET/POST /api/forms/[id]"]:::server
        APISubmit["POST /api/forms/[id]/submit"]:::server
        APIPublish["POST /api/forms/publish"]:::server
        FBLogic["Form Builder API Logic"]:::server
        FVLogic["Form Viewer API Logic"]:::server
        ML["MongoDB Connection"]:::shared
        Schema["Mongoose Form Schema"]:::shared
    end

    %% Database
    DB["MongoDB Cluster"]:::db

    %% Shared Libraries
    subgraph "Shared Libraries"
        direction TB
        CONST["Shared Constants"]:::shared
        TM["Tailwind Merge Utility"]:::shared
    end

    %% Flows: Frontend interactions
    B -->|"Interacts"| FBUI
    B -->|"Interacts"| QB
    B -->|"Loads SSR Page"| PFP

    FBUI -->|"Uses Store"| ZS
    QB -->|"Uses Store"| ZS
    FBUI -->|"Uses UI"| SU
    QB -->|"Uses UI"| SU
    FP -->|"Uses UI"| SU
    FP -->|"Uses Store"| ZS

    NApp --> FBUI
    NApp --> QB
    NApp --> FP
    NApp --> PFP

    %% Flows: API calls
    FBUI -->|"POST form"| APIIndex
    FBUI -->|"POST publish"| APIPublish
    FP -->|"GET form data"| APIID
    PFP -->|"SSR GET form"| APIID
    APIID -->|"Returns form"| PFP
    APISubmit -->|"Writes responses"| DB

    APIIndex -->|"Calls Logic"| FBLogic
    APIPublish -->|"Calls Logic"| FBLogic
    FP -->|"GET preview data"| FVLogic
    FVLogic -->|"Fetch data"| APIID

    %% Server to Data Access
    APIIndex -->|"Calls DB Layer"| ML
    APIID -->|"Calls DB Layer"| ML
    APISubmit -->|"Calls DB Layer"| ML
    APIPublish -->|"Calls DB Layer"| ML

    ML -->|"Uses Schema"| Schema
    Schema -->|"Reads/Writes"| DB

    %% Shared Libraries usage
    SU --> CONST
    SU --> TM
    FBLogic --> CONST
    FVLogic --> CONST

    %% Click Events
    click FBUI "https://github.com/shreykoradia/peerlist-shrey/tree/main/src/modules/form-builder/components"
    click FBLogic "https://github.com/shreykoradia/peerlist-shrey/blob/main/src/modules/form-builder/api.ts"
    click QB "https://github.com/shreykoradia/peerlist-shrey/tree/main/src/modules/question-builder/components"
    click FP "https://github.com/shreykoradia/peerlist-shrey/blob/main/src/modules/form-viewer/components/form-preview.tsx"
    click FVLogic "https://github.com/shreykoradia/peerlist-shrey/blob/main/src/modules/form-viewer/api.ts"
    click PFP "https://github.com/shreykoradia/peerlist-shrey/blob/main/src/app/form/[formId]/page.tsx"
    click NApp "https://github.com/shreykoradia/peerlist-shrey/tree/main/src/app"
    click APIIndex "https://github.com/shreykoradia/peerlist-shrey/blob/main/src/pages/api/forms/index.ts"
    click APIID "https://github.com/shreykoradia/peerlist-shrey/blob/main/src/pages/api/forms/[id]/index.ts"
    click APISubmit "https://github.com/shreykoradia/peerlist-shrey/blob/main/src/pages/api/forms/[id]/submit.ts"
    click APIPublish "https://github.com/shreykoradia/peerlist-shrey/blob/main/src/pages/api/forms/publish.ts"
    click ZS "https://github.com/shreykoradia/peerlist-shrey/blob/main/src/shared/store/form.ts"
    click SU "https://github.com/shreykoradia/peerlist-shrey/tree/main/src/shared/ui"
    click ML "https://github.com/shreykoradia/peerlist-shrey/blob/main/src/shared/lib/mongoDb.ts"
    click Schema "https://github.com/shreykoradia/peerlist-shrey/blob/main/src/model/form.model.ts"
    click CONST "https://github.com/shreykoradia/peerlist-shrey/blob/main/src/shared/lib/constant.ts"
    click TM "https://github.com/shreykoradia/peerlist-shrey/blob/main/src/shared/lib/tailwind-merge.ts"

    %% Styles
    classDef frontend fill:#E0F7FA,stroke:#006064,color:#006064;
    classDef server fill:#E8F5E9,stroke:#1B5E20,color:#1B5E20;
    classDef db fill:#FFF3E0,stroke:#E65100,color:#E65100;
    classDef shared fill:#ECEFF1,stroke:#607D8B,color:#37474F;
    classDef external fill:#F3E5F5,stroke:#6A1B9A,color:#4A148C;
```
