# deepakpokhrel1/local-services architecture

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

- Interactive diagram: https://gitdiagram.com/deepakpokhrel1/local-services
- Repository: https://github.com/deepakpokhrel1/local-services

## Overview

##### Project Type and Purpose
- This is a full-stack web application called “Local Services Directory.”
- Frontend: React.js SPA with Redux and Tailwind CSS for UI/UX.
- Backend: Node.js + Express.js monolith implementing REST APIs.
- Database: PostgreSQL (accessed via Prisma ORM or Sequelize).
- External services: Google Maps API for geolocation, Stripe for payments, email (SMTP/Nodemailer), SMS, Sentry for error tracking.

##### File Structure Analysis
- Top level:
- backend/ – Express server, routes, controllers, services, models, migrations, seeders, middleware, configuration, logs.
- frontend/ – React app: public assets, src/components, pages, styles, mock data, proxy setup.
- nginx/ – reverse-proxy config.
- docker-compose.yml & Dockerfile – container definitions.
- crontab.txt – scheduled jobs (database backups).
- Backend follows MVC-style:
- routes → controllers → services → models (ORM)
- middleware layer for auth, CORS, rate limiting, error handling.
- migrations/seeders for schema and dummy data.
- Frontend organizes by feature:
- components (UI + domain), pages (routes), API modules (axios wrappers), contexts.

##### README Insights
- The stack summary and environment setup clarify external dependencies and runtime pieces.

## Diagram (Mermaid)

```mermaid
flowchart TD
    classDef inhouse fill:#ADD8E6,stroke:#000,stroke-width:1px
    classDef external fill:#90EE90,stroke:#000,stroke-width:1px
    classDef db fill:#FFD700,stroke:#000,stroke-width:1px
    classDef container fill:#FFEFD5,stroke:#000,stroke-width:1px
    classDef async stroke-dasharray: 5 5

    %% User and Browser
    User["User"]:::external
    Browser["Browser / React SPA"]:::inhouse
    User -->|"interacts with"| Browser

    %% Docker Compose Group
    subgraph "Docker Compose Environment" 
        direction TB
        Nginx["Nginx Proxy"]:::container
        Frontend["Frontend Container"]:::container
        Backend["Backend Container"]:::container
        Postgres["PostgreSQL DB"]:::db
    end

    Browser -->|"HTTPS"| Nginx
    Nginx -->|"serves static assets"| Frontend
    Nginx -->|"forwards API requests"| Backend

    %% Frontend Details
    subgraph "Frontend Container"
        direction TB
        FE_Index["Entry Point\nindex.html / index.js"]:::inhouse
        FE_Components["Components & Pages"]:::inhouse
        FE_Styles["Styles & Assets"]:::inhouse
    end

    Frontend --> FE_Index
    Frontend --> FE_Components
    Frontend --> FE_Styles

    %% Backend Details
    subgraph "Backend Container"
        direction TB
        BE_Entry["Entry Point\nserver.js"]:::inhouse
        subgraph "Configuration"
            ConfigApp["app.config.js"]:::inhouse
            ConfigDB["database.js"]:::inhouse
            ConfigEnv["env.js / config.js"]:::inhouse
        end
        subgraph "Routing Layer"
            Routes["Routes"]:::inhouse
        end
        subgraph "Controllers Layer"
            Controllers["Controllers"]:::inhouse
        end
        subgraph "Services Layer"
            Services["Services"]:::inhouse
        end
        subgraph "Models & ORM"
            Models["ORM Models"]:::inhouse
        end
        subgraph "Migrations & Seeders"
            Migrations["Migrations"]:::inhouse
            Seeders["Seeders"]:::inhouse
        end
        subgraph "Middleware Layer"
            Middleware["Middleware"]:::inhouse
        end
        subgraph "Utilities"
            Utils["Utility Modules"]:::inhouse
        end
        subgraph "Logs"
            Logs["Logs Directory"]:::inhouse
        end
    end

    Backend --> BE_Entry
    BE_Entry --> ConfigApp
    BE_Entry --> ConfigDB
    BE_Entry --> ConfigEnv
    BE_Entry --> Routes
    Routes --> Controllers
    Controllers --> Services
    Services --> Models
    Models --> Postgres
    Controllers -->|uses| Utils
    Controllers -->|uses| Middleware
    BE_Entry --> Logs
    Routes --> Middleware
    Models --> ConfigDB
    Migrations --> Postgres
    Seeders --> Postgres

    %% External Services
    GoogleMaps["Google Maps API"]:::external
    Stripe["Stripe API"]:::external
    EmailSvc["Email (SMTP/Nodemailer)"]:::external
    SMS["SMS Gateway"]:::external
    Sentry["Sentry"]:::external
    S3["S3 Backup Storage"]:::external

    Backend -->|REST & SDK| GoogleMaps
    Backend -->|REST & SDK| Stripe
    Backend -->|SMTP| EmailSvc
    Backend -->|REST| SMS
    Backend -->|errors/traces| Sentry

    %% Cron Backups
    Cron["Cron Scheduler"]:::external
    BackupScript["Backup Script"]:::inhouse
    Cron -.->|scheduled| BackupScript
    BackupScript -->|dump| Postgres
    BackupScript -->|upload| S3

    %% Monitoring
    Prometheus["Prometheus"]:::external
    Grafana["Grafana"]:::external
    Backend -->|metrics endpoint| Prometheus
    Prometheus -->|visualize| Grafana

    %% CI/CD
    CICD["GitHub Actions CI/CD"]:::external
    CICD -->|build & deploy| Frontend
    CICD -->|build & deploy| Backend

    %% Click Events
    click Browser "https://github.com/deepakpokhrel1/local-services/tree/main/frontend/"
    click FE_Components "https://github.com/deepakpokhrel1/local-services/tree/main/frontend/src/components/"
    click FE_Index "https://github.com/deepakpokhrel1/local-services/blob/main/frontend/public/index.html"
    click FE_Index "https://github.com/deepakpokhrel1/local-services/blob/main/frontend/src/index.js"
    click FE_Styles "https://github.com/deepakpokhrel1/local-services/tree/main/frontend/src/styles/"
    click Frontend "https://github.com/deepakpokhrel1/local-services/blob/main/frontend/src/setupProxy.js"
    click Nginx "https://github.com/deepakpokhrel1/local-services/blob/main/nginx/conf.d/default.conf"
    click CICD "https://github.com/deepakpokhrel1/local-services/blob/main/docker-compose.yml"
    click CICD "https://github.com/deepakpokhrel1/local-services/tree/main/Dockerfile"
    click Cron "https://github.com/deepakpokhrel1/local-services/blob/main/crontab.txt"
    click BE_Entry "https://github.com/deepakpokhrel1/local-services/blob/main/backend/server.js"
    click ConfigApp "https://github.com/deepakpokhrel1/local-services/blob/main/backend/config/app.config.js"
    click ConfigDB "https://github.com/deepakpokhrel1/local-services/blob/main/backend/config/database.js"
    click ConfigEnv "https://github.com/deepakpokhrel1/local-services/blob/main/backend/config/config.js"
    click ConfigEnv "https://github.com/deepakpokhrel1/local-services/blob/main/backend/config/env.js"
    click Routes "https://github.com/deepakpokhrel1/local-services/tree/main/backend/src/routes/"
    click Controllers "https://github.com/deepakpokhrel1/local-services/tree/main/backend/src/controllers/"
    click Services "https://github.com/deepakpokhrel1/local-services/tree/main/backend/src/services/"
    click Models "https://github.com/deepakpokhrel1/local-services/tree/main/backend/src/models/"
    click Migrations "https://github.com/deepakpokhrel1/local-services/tree/main/backend/src/migrations/"
    click Seeders "https://github.com/deepakpokhrel1/local-services/tree/main/backend/src/seeders/"
    click Middleware "https://github.com/deepakpokhrel1/local-services/tree/main/backend/src/middleware/"
    click Utils "https://github.com/deepakpokhrel1/local-services/tree/main/backend/src/utils/"
    click Logs "https://github.com/deepakpokhrel1/local-services/tree/main/backend/logs/"
    click BackupScript "https://github.com/deepakpokhrel1/local-services/blob/main/backend/src/services/storage.service.js"
    click Stripe "https://github.com/deepakpokhrel1/local-services/blob/main/backend/src/utils/stripe.js"
    click Stripe "https://github.com/deepakpokhrel1/local-services/blob/main/backend/src/services/payment.service.js"
    click GoogleMaps "https://github.com/deepakpokhrel1/local-services/blob/main/backend/src/services/maps.service.js"
    click GoogleMaps "https://github.com/deepakpokhrel1/local-services/blob/main/backend/src/utils/maps.js"
    click EmailSvc "https://github.com/deepakpokhrel1/local-services/blob/main/backend/src/services/email.service.js"
    click EmailSvc "https://github.com/deepakpokhrel1/local-services/blob/main/backend/src/utils/nodemailer.js"
    click SMS "https://github.com/deepakpokhrel1/local-services/blob/main/backend/src/services/sms.service.js"
    click SMS "https://github.com/deepakpokhrel1/local-services/blob/main/backend/src/utils/smsService.js"
```
