# siddharthswami23/code-snippet-app-docker architecture

> Architecture diagram of the GitHub repository siddharthswami23/code-snippet-app-docker, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-08-15). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/siddharthswami23/code-snippet-app-docker
- Repository: https://github.com/siddharthswami23/code-snippet-app-docker

## Overview

##### Project type and purpose
- From the file tree and minimal README, this is a full-stack “code snippet” web application containerized with Docker and orchestrated locally with Docker Compose, with a Jenkins-driven CI/CD pipeline.
- The client folder contains a TypeScript React/Vite UI (“code‐snippets”), the server folder holds a Node.js/Express REST API (snippets, users, comments), and Jenkinsfiles + vars/*.groovy scripts implement CI/CD.

##### File structure
- Top-level:
- Docker-compose.yaml – defines multi-container setup (client, server, likely a database)
- JenkinsFile + vars/*.groovy – declarative pipeline steps for build, test, deploy
- client/ – React+TypeScript app (component hierarchy, context, UI primitives)
- server/ – Express API with controllers, models, routes, and DB config
- Patterns:
- React uses a component/UI folder, context for global state, Vite for bundling
- Server follows an MVC‐style pattern (models/controllers/routes)
- Env and config:
- server/.env for secrets, server/config/db.js for DB connection
- client/vite.config.ts + tsconfig.* for build config
- Dockerfiles in both client/ and server/

##### Key insights from README
- The README only names the project (code-snippet-app-docker) but implies Docker usage.

##### Main components and interactions
1. Browser (end user)
2. React Frontend (client container)
3. Node/Express Backend (server container)
4. Database (e.g., MongoDB container or external service)
5. CI/CD (Jenkins master + agents using JenkinsFile and shared vars)
6. Docker Registry (optional if pushing images)
b. Relationships:
- Browser ↔ Frontend: REST/API or GraphQL calls over HTTP(s)
- Frontend → Backend: fetch calls for CRUD on snippets, users, comments
- Backend → Database: direct driver connection (per server/config/db.js)
- Jenkins → Git Repo: pulls code, then → Docker Build → Registry (or local images) → Docker-Compose up for staging/production
c. Architectural patterns / design principles:
- Separation of concerns: UI vs API vs Data Layer
- React component model with context/provider for global state
- MVC on backend: controllers handle requests, models define schema, routes map endpoints
- Containerization: each tier isolated in its own Docker container
- CI/CD as code: JenkinsFile + shared Groovy library
d. Key technologies: React, TypeScript, Vite, Express, Node.js, MongoDB (or similar), Docker, Docker Compose, Jenkins, Groovy

##### Critical details to capture
- Do not omit the shared Groovy library (vars folder) – it’s central to CI/CD.
- Configuration files as part of each container: Dockerfile + config/env.
- Explicitly note the project’s multi-container network (defined in Docker-compose.yaml).
- MVC structure in the backend and the component/context structure in the frontend.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Actors
    Browser["User Browser"]:::infra
    Jenkins["Jenkins CI/CD"]:::infra

    %% Docker Compose Group
    subgraph "Docker Compose Environment"
        direction TB
        subgraph "Frontend Container"
            direction TB
            FE_Dir["client/"]:::frontend
            FE_Dockerfile["Dockerfile"]:::frontend
            FE_Main["src/main.tsx"]:::frontend
            FE_Router["src/Routes/AppRouter.tsx"]:::frontend
            FE_Components["src/components/"]:::frontend
            FE_Context["src/context/AppContext.tsx"]:::frontend
            FE_Vite["vite.config.ts"]:::frontend
            FE_TSConfig["tsconfig.json"]:::frontend
            FE_Pkg["package.json"]:::frontend
        end
        subgraph "Backend Container"
            direction TB
            BE_Dir["server/"]:::backend
            BE_Dockerfile["Dockerfile"]:::backend
            BE_Server["server.js"]:::backend
            BE_DBConfig["config/db.js"]:::backend
            BE_Controller1["controllers/snippet.controller.js"]:::backend
            BE_Controller2["controllers/user.controller.js"]:::backend
            BE_Controller3["controllers/comment.controller.js"]:::backend
            BE_Model1["models/snippet.model.js"]:::backend
            BE_Model2["models/user.model.js"]:::backend
            BE_Route1["routes/snippet.routes.js"]:::backend
            BE_Route2["routes/user.routes.js"]:::backend
            BE_Route3["routes/comment.routes.js"]:::backend
            BE_Pkg["package.json"]:::backend
        end
        DB["MongoDB"]:::database
    end

    %% CI/CD and Registry
    Registry["Docker Registry"]:::infra

    %% Relationships
    Browser -->|"HTTP GET/POST to UI"| FE_Dir
    FE_Dir -->|"fetch /api/... "| BE_Server
    BE_Server -->|"MongoDB CRUD"| DB

    Jenkins -->|"Clone Repo"| FE_Dir
    Jenkins -->|"Clone Repo"| BE_Dir
    Jenkins -->|"Build Images"| Registry
    Jenkins -->|"Deploy via docker-compose up"| DB

    %% Click Events
    click FE_Dir "https://github.com/siddharthswami23/code-snippet-app-docker/tree/main/client/"
    click FE_Dockerfile "https://github.com/siddharthswami23/code-snippet-app-docker/tree/main/client/Dockerfile"
    click FE_Main "https://github.com/siddharthswami23/code-snippet-app-docker/blob/main/client/src/main.tsx"
    click FE_Router "https://github.com/siddharthswami23/code-snippet-app-docker/blob/main/client/src/Routes/AppRouter.tsx"
    click FE_Components "https://github.com/siddharthswami23/code-snippet-app-docker/tree/main/client/src/components/"
    click FE_Context "https://github.com/siddharthswami23/code-snippet-app-docker/blob/main/client/src/context/AppContext.tsx"
    click FE_Vite "https://github.com/siddharthswami23/code-snippet-app-docker/blob/main/client/vite.config.ts"
    click FE_TSConfig "https://github.com/siddharthswami23/code-snippet-app-docker/blob/main/client/tsconfig.json"
    click FE_Pkg "https://github.com/siddharthswami23/code-snippet-app-docker/blob/main/client/package.json"

    click BE_Dir "https://github.com/siddharthswami23/code-snippet-app-docker/tree/main/server/"
    click BE_Dockerfile "https://github.com/siddharthswami23/code-snippet-app-docker/tree/main/server/Dockerfile"
    click BE_Server "https://github.com/siddharthswami23/code-snippet-app-docker/blob/main/server/server.js"
    click BE_DBConfig "https://github.com/siddharthswami23/code-snippet-app-docker/blob/main/server/config/db.js"
    click BE_Controller1 "https://github.com/siddharthswami23/code-snippet-app-docker/blob/main/server/controllers/snippet.controller.js"
    click BE_Controller2 "https://github.com/siddharthswami23/code-snippet-app-docker/blob/main/server/controllers/user.controller.js"
    click BE_Controller3 "https://github.com/siddharthswami23/code-snippet-app-docker/blob/main/server/controllers/comment.controller.js"
    click BE_Model1 "https://github.com/siddharthswami23/code-snippet-app-docker/blob/main/server/models/snippet.model.js"
    click BE_Model2 "https://github.com/siddharthswami23/code-snippet-app-docker/blob/main/server/models/user.model.js"
    click BE_Route1 "https://github.com/siddharthswami23/code-snippet-app-docker/blob/main/server/routes/snippet.routes.js"
    click BE_Route2 "https://github.com/siddharthswami23/code-snippet-app-docker/blob/main/server/routes/user.routes.js"
    click BE_Route3 "https://github.com/siddharthswami23/code-snippet-app-docker/blob/main/server/routes/comment.routes.js"
    click BE_Pkg "https://github.com/siddharthswami23/code-snippet-app-docker/blob/main/server/package.json"

    click DB "https://github.com/siddharthswami23/code-snippet-app-docker/blob/main/Docker-compose.yaml"
    click Jenkins "https://github.com/siddharthswami23/code-snippet-app-docker/tree/main/JenkinsFile"
    click Registry "https://github.com/siddharthswami23/code-snippet-app-docker/blob/main/vars/clone.groovy"
    click Registry "https://github.com/siddharthswami23/code-snippet-app-docker/blob/main/vars/build-container.groovy"
    click Registry "https://github.com/siddharthswami23/code-snippet-app-docker/blob/main/vars/run-container.groovy"
    click Registry "https://github.com/siddharthswami23/code-snippet-app-docker/blob/main/vars/demoCall.groovy"
    click Registry "https://github.com/siddharthswami23/code-snippet-app-docker/blob/main/vars/hello.groovy"

    %% Styles
    classDef frontend fill:#e0f7fa,stroke:#006064,color:#006064
    classDef backend fill:#e8f5e9,stroke:#2e7d32,color:#2e7d32
    classDef database fill:#fff3e0,stroke:#ef6c00,color:#ef6c00
    classDef infra fill:#eceff1,stroke:#607d8b,color:#37474f
```
