# srajasimman/mern-assessment-app architecture

> Architecture diagram of the GitHub repository srajasimman/mern-assessment-app, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-04-26). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/srajasimman/mern-assessment-app
- Repository: https://github.com/srajasimman/mern-assessment-app

## Overview

##### Project type and purpose
- This is a full-stack MERN (MongoDB, Express, React, Node.js) web application—a customizable online assessment platform.
- Frontend (“client/”): React + TypeScript + Material UI SPA that administrators and responders use.
- Backend (“server/”): Node.js + Express REST API with Mongoose models exposing endpoints for assessments and responses.
- Database: MongoDB for persisting assessments and responses.
- Deployment: Docker (dev & prod), Nginx for serving static assets and proxying API.

##### File structure
Top level
- client/ – React app with Dockerfiles (dev/prod), nginx.conf for production, source under src/, services/api.ts for HTTP calls.
- server/ – Express app split into config, controllers, models, middleware, routes, with dev/prod Dockerfiles.
- docker-compose.dev.yml & docker-compose.prod.yml – multi-container setups for dev and prod (client, server, Mongo).
- CI/CD – .github/workflows for build/test pipelines.
- deploy-prod.sh, docker-bake.hcl – scripts for building and pushing production images.

##### README for additional insights
- Confirms MERN stack, React Router v6, Axios, Mongoose.
- Describes API endpoints, environment variables, commands for dev/prod.
- Future enhancements hint at JWT auth, analytics, etc.

a. Main components
- User Devices (Browsers)
- Frontend SPA (React)
- Reverse Proxy / Static Server (Nginx in prod)
- Backend REST API (Node/Express)
- Database (MongoDB)
- (Optionally) CI/CD pipeline (GitHub Actions)
b. Relationships & interactions
1. User interacts with React SPA served by Nginx (prod) or webpack‐dev server (dev).
2. SPA issues HTTP(S) calls via Axios to Express API endpoints (/api/assessments, /api/responses).
3. Express controllers invoke Mongoose models to read/write documents in MongoDB.
4. Responses flow back to SPA which updates UI.
5. In production, image builds and pushes occur via deploy-prod.sh and docker-bake; CI runs tests on push/PR.
c. Architectural patterns and principles
- Separation of concerns: UI layer vs. API layer vs. data layer.
- MVC‐esque structure in backend: controllers ↔ models ↔ routes.
- Componentized React UI in client/src/components.
- Environment‐specific Docker configurations.
d. Key technologies
- React + TypeScript, Material UI, React Router, Axios
- Node.js, Express.js, Mongoose, MongoDB
- Docker, Docker Compose (dev & prod), Nginx (static + proxy)
- GitHub Actions CI

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% User Layer
    Browser["User Browser"]:::ui

    %% Frontend Container
    subgraph "Client Container (Dev & Prod)" 
        direction TB
        Webpack["Webpack Dev Server (3000)"]:::infra
        Nginx["Nginx (80/443)"]:::infra
        ReactSPA["React SPA"]:::ui
    end

    subgraph "React SPA Details"
        direction TB
        Index["index.tsx"]:::ui
        App["App.tsx"]:::ui
        AdminComp["components/admin/"]:::ui
        AssessComp["components/assessment/"]:::ui
        NavBar["NavBar.tsx"]:::ui
        APIService["services/api.ts"]:::ui
        Types["types/index.ts"]:::ui
    end

    %% Backend Container
    subgraph "Server Container (Dev & Prod)"
        direction TB
        Express["server.js"]:::api
        Config["config/config.js"]:::api
        Middleware["middleware/middleware.js"]:::api
        AssController["controllers/assessmentController.js"]:::api
        RespController["controllers/responseController.js"]:::api
        AssRoutes["routes/assessments.js"]:::api
        RespRoutes["routes/responses.js"]:::api
        AssModel["models/Assessment.js"]:::data
        RespModel["models/Response.js"]:::data
    end

    %% Database
    MongoDB["MongoDB"]:::data

    %% CI/CD
    subgraph "CI/CD Pipeline"
        direction TB
        CI_CI["ci.yml"]:::ci
        CI_PR["pr.yml"]:::ci
    end

    %% Docker & Deployment
    subgraph "Docker Infrastructure"
        direction TB
        ComposeDev["docker-compose.dev.yml"]:::infra
        ComposeProd["docker-compose.prod.yml"]:::infra
        ClientDevDocker["client/Dockerfile.dev"]:::infra
        ClientProdDocker["client/Dockerfile.prod"]:::infra
        ServerDevDocker["server/Dockerfile.dev"]:::infra
        ServerProdDocker["server/Dockerfile.prod"]:::infra
        BakeConfig["docker-bake.hcl"]:::infra
        DeployScript["deploy-prod.sh"]:::infra
    end

    %% Connections
    Browser -->|loads SPA| Webpack
    Browser -->|loads SPA| Nginx
    Webpack -->|serves| ReactSPA
    Nginx -->|serves| ReactSPA
    ReactSPA -->|renders| Index
    ReactSPA -->|initializes| App
    ReactSPA -->|uses| AdminComp
    ReactSPA -->|uses| AssessComp
    ReactSPA -->|uses| NavBar
    ReactSPA -->|calls| APIService
    ReactSPA -->|uses| Types
    ReactSPA -->|calls API| Express
    Express -->|routes to| AssRoutes
    Express -->|routes to| RespRoutes
    AssRoutes -->|uses| AssController
    RespRoutes -->|uses| RespController
    AssController -->|queries| AssModel
    RespController -->|queries| RespModel
    Express -->|connects| MongoDB
    CI_CI -->|runs| ComposeDev
    CI_CI -->|runs| ComposeProd
    CI_PR -->|runs| ComposeDev
    CI_PR -->|runs| ComposeProd
    ComposeDev -->|builds| ClientDevDocker
    ComposeDev -->|builds| ServerDevDocker
    ComposeProd -->|builds| ClientProdDocker
    ComposeProd -->|builds| ServerProdDocker
    DeployScript -->|uses| BakeConfig

    %% Click Events
    click Index "https://github.com/srajasimman/mern-assessment-app/blob/main/client/src/index.tsx"
    click App "https://github.com/srajasimman/mern-assessment-app/blob/main/client/src/App.tsx"
    click AdminComp "https://github.com/srajasimman/mern-assessment-app/tree/main/client/src/components/admin/"
    click AssessComp "https://github.com/srajasimman/mern-assessment-app/tree/main/client/src/components/assessment/"
    click NavBar "https://github.com/srajasimman/mern-assessment-app/blob/main/client/src/components/layout/NavBar.tsx"
    click APIService "https://github.com/srajasimman/mern-assessment-app/blob/main/client/src/services/api.ts"
    click Types "https://github.com/srajasimman/mern-assessment-app/blob/main/client/src/types/index.ts"
    click ReactSPA "https://github.com/srajasimman/mern-assessment-app/tree/main/client/src/"
    click Webpack "https://github.com/srajasimman/mern-assessment-app/blob/main/client/Dockerfile.dev"
    click Nginx "https://github.com/srajasimman/mern-assessment-app/blob/main/client/nginx.conf"
    click Express "https://github.com/srajasimman/mern-assessment-app/blob/main/server/server.js"
    click Config "https://github.com/srajasimman/mern-assessment-app/blob/main/server/config/config.js"
    click Middleware "https://github.com/srajasimman/mern-assessment-app/blob/main/server/middleware/middleware.js"
    click AssController "https://github.com/srajasimman/mern-assessment-app/blob/main/server/controllers/assessmentController.js"
    click RespController "https://github.com/srajasimman/mern-assessment-app/blob/main/server/controllers/responseController.js"
    click AssRoutes "https://github.com/srajasimman/mern-assessment-app/blob/main/server/routes/assessments.js"
    click RespRoutes "https://github.com/srajasimman/mern-assessment-app/blob/main/server/routes/responses.js"
    click AssModel "https://github.com/srajasimman/mern-assessment-app/blob/main/server/models/Assessment.js"
    click RespModel "https://github.com/srajasimman/mern-assessment-app/blob/main/server/models/Response.js"
    click CI_CI "https://github.com/srajasimman/mern-assessment-app/blob/main/.github/workflows/ci.yml"
    click CI_PR "https://github.com/srajasimman/mern-assessment-app/blob/main/.github/workflows/pr.yml"
    click ComposeDev "https://github.com/srajasimman/mern-assessment-app/blob/main/docker-compose.dev.yml"
    click ComposeProd "https://github.com/srajasimman/mern-assessment-app/blob/main/docker-compose.prod.yml"
    click ClientDevDocker "https://github.com/srajasimman/mern-assessment-app/blob/main/client/Dockerfile.dev"
    click ClientProdDocker "https://github.com/srajasimman/mern-assessment-app/blob/main/client/Dockerfile.prod"
    click ServerDevDocker "https://github.com/srajasimman/mern-assessment-app/blob/main/server/Dockerfile.dev"
    click ServerProdDocker "https://github.com/srajasimman/mern-assessment-app/blob/main/server/Dockerfile.prod"
    click BakeConfig "https://github.com/srajasimman/mern-assessment-app/blob/main/docker-bake.hcl"
    click DeployScript "https://github.com/srajasimman/mern-assessment-app/blob/main/deploy-prod.sh"

    %% Styles
    classDef ui fill:#E3F2FD,stroke:#64B5F6,color:#0D47A1
    classDef api fill:#E8F5E9,stroke:#66BB6A,color:#1B5E20
    classDef data fill:#FFF3E0,stroke:#FFA726,color:#E65100
    classDef infra fill:#ECEFF1,stroke:#B0BEC5,color:#37474F
    classDef ci fill:#F3E5F5,stroke:#BA68C8,color:#4A148C
```
