# sanjay004mk/travel-tracker architecture

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

- Interactive diagram: https://gitdiagram.com/sanjay004mk/travel-tracker
- Repository: https://github.com/sanjay004mk/travel-tracker

## Overview

##### Project type and purpose
- This is a full-stack web application (“Path Finder: A Trip & Expense Manager”) consisting of:
- A React single-page application (Material-Tailwind, Vite)
- A Node.js/Express REST API
- A MongoDB database
- Containerization via Docker Compose
- CI/CD via Jenkins

##### File structure
- Top-level:
- backend/ – Express app, database models, routes, tests, Dockerfile, env
- frontend/ – React app (src/, public/, layouts, pages, widgets), configs, Dockerfile, env
- docker-compose.yml & docker-test.yml – multi-container definitions
- README.md – project overview, tech stack, deployment, testing, CI/CD
- backend/DETAILS:
- database/ – Mongoose connection and schema files (user.js, trip.js, expense.js) + tests
- routes/ – Express routers by resource (user-records.js, trip-records.js, etc.)
- server.js & app.js – Express app setup, middleware (require-middleware.js)
- frontend/DETAILS:
- src/ – main.jsx, App.jsx, React contexts, API util, page components, reusable widgets (cards, charts, layout)
- public/ – static assets, index.html
- configurations – jsconfig, postcss, tailwind, vite, prettier

##### README for additional insights
- Architectural notes: JWT auth with secure cookies, bcryptjs hashing
- Docker Compose brings up three services: frontend, backend, MongoDB
- docker-test.yml for containerized tests
- CI/CD pipeline in Jenkinsfile runs docker-compose → build → test

a. **Frontend SPA** (React/Vite)
- Serves UI, communicates over HTTP(S)
- Hosts Material Tailwind UI + Recharts
b. **Backend API** (Node/Express)
- Authentication layer (JWT issuance & verification via require-middleware)
- Business logic in routes (users, trips, expenses, metrics)
- Database access via Mongoose models (User, Trip, Expense)
c. **MongoDB**
- Persistent storage for users, trips, expenses, activity notes
d. **External Services & DevOps**
- Docker Compose orchestrator
- Jenkins CI pipeline
- (Optional) Vercel hosting for frontend – vercel.json

##### Relationships & dataflow
- Frontend → (HTTP REST) → Backend
- Backend → (Mongoose) → MongoDB
- JWT flows: upon login, API issues token → client stores in secure cookie → subsequent API calls include token
- Docker Compose ties together frontend, backend, MongoDB on a private network
- Jenkins triggers Docker Compose → builds images → runs tests against backend container

##### Architectural patterns & design principles
- MVC-style separation in backend:
- Models (database/)
- Routes/Controllers (routes/)
- Middleware (require-middleware.js)
- React component hierarchy / Atomic design in frontend:
- Pages → Layouts → Widgets → UI elements
- Containerization for environment parity
- Layered security with JWT & secure cookies
- Test-driven development with Vitest (unit & integration)

- Frontend: React app, API util
- Backend: Express server, route modules, auth middleware, Mongoose models
- Database: MongoDB
- Container layer: Docker Compose grouping
- DevOps: Jenkins (CI/CD)
- Security flow: JWT token issuance & verification

## Diagram (Mermaid)

```mermaid
flowchart TD
    subgraph "Presentation Layer"
        subgraph "React SPA (Vite)"
            AMain["main.jsx"]:::frontend
            AApp["App.jsx"]:::frontend
        end
        B["API Utility"]:::frontend
        C["React Contexts"]:::frontend
        D["Pages"]:::frontend
        E["Layouts"]:::frontend
        subgraph "Widgets"
            F1["Cards"]:::frontend
            F2["Charts"]:::frontend
            F3["Layout Elements"]:::frontend
        end
    end

    subgraph "Application Layer"
        G["Express API"]:::backend
        H["Auth Middleware (JWT)"]:::backend
        subgraph "Routes"
            I["User Routes"]:::backend
            J["Trip Routes"]:::backend
            K["Expense Routes"]:::backend
            L["Metrics Routes"]:::backend
        end
        subgraph "Models"
            M["User Model"]:::backend
            N["Trip Model"]:::backend
            O["Expense Model"]:::backend
        end
    end

    subgraph "Data Layer"
        P[(MongoDB)]:::database
    end

    subgraph "DevOps"
        R["Docker Compose"]:::devops
        S["Jenkins CI/CD"]:::devops
    end

    AMain -->|"renders"| AApp
    AApp -->|"uses API util"| B
    B -->|"calls API"| G
    C -->|"provides state"| AApp
    D -->|"routed by App"| AApp
    E -->|"wrapped by Layouts"| D
    F1 -->|"used in pages"| D
    F2 -->|"used in pages"| D
    F3 -->|"used in layouts"| E

    AApp -->|"HTTP + JWT"| G
    G -->|"verifies JWT"| H
    H -->|"protects"| I
    G -->|"routes to"| J
    G -->|"routes to"| K
    G -->|"routes to"| L

    I -->|"queries"| M
    J -->|"queries"| N
    K -->|"queries"| O
    G -->|"mongoose"| P

    S -.->|"triggers"| R
    R -->|"orchestrates"| AMain
    R -->|"orchestrates"| G
    R -->|"orchestrates"| P

    click AMain "https://github.com/sanjay004mk/travel-tracker/blob/main/frontend/src/main.jsx"
    click AApp "https://github.com/sanjay004mk/travel-tracker/blob/main/frontend/src/App.jsx"
    click B "https://github.com/sanjay004mk/travel-tracker/blob/main/frontend/src/util/api.js"
    click C "https://github.com/sanjay004mk/travel-tracker/blob/main/frontend/src/context/index.jsx"
    click D "https://github.com/sanjay004mk/travel-tracker/tree/main/frontend/src/pages/"
    click E "https://github.com/sanjay004mk/travel-tracker/tree/main/frontend/src/layouts/"
    click F1 "https://github.com/sanjay004mk/travel-tracker/tree/main/frontend/src/widgets/cards/"
    click F2 "https://github.com/sanjay004mk/travel-tracker/tree/main/frontend/src/widgets/charts/"
    click F3 "https://github.com/sanjay004mk/travel-tracker/tree/main/frontend/src/widgets/layout/"
    click G "https://github.com/sanjay004mk/travel-tracker/tree/main/backend/"
    click H "https://github.com/sanjay004mk/travel-tracker/blob/main/backend/require-middleware.js"
    click I "https://github.com/sanjay004mk/travel-tracker/blob/main/backend/routes/user-records.js"
    click J "https://github.com/sanjay004mk/travel-tracker/blob/main/backend/routes/trip-records.js"
    click K "https://github.com/sanjay004mk/travel-tracker/blob/main/backend/routes/expense-records.js"
    click L "https://github.com/sanjay004mk/travel-tracker/blob/main/backend/routes/metrics-records.js"
    click M "https://github.com/sanjay004mk/travel-tracker/blob/main/backend/database/user.js"
    click N "https://github.com/sanjay004mk/travel-tracker/blob/main/backend/database/trip.js"
    click O "https://github.com/sanjay004mk/travel-tracker/blob/main/backend/database/expense.js"
    click R "https://github.com/sanjay004mk/travel-tracker/blob/main/docker-compose.yml"
    click S "https://github.com/sanjay004mk/travel-tracker/blob/main/README.md"

    classDef frontend fill:#cce5ff,stroke:#0366d6,color:#0366d6
    classDef backend fill:#d4edda,stroke:#155724,color:#155724
    classDef database fill:#ffe5b4,stroke:#cc8400,color:#cc8400
    classDef devops fill:#e2e3e5,stroke:#6c757d,color:#6c757d
```
