# utsav-patell/googlesolutions_backend_public architecture

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

- Interactive diagram: https://gitdiagram.com/utsav-patell/googlesolutions_backend_public
- Repository: https://github.com/utsav-patell/googlesolutions_backend_public

## Overview

##### Project type and purpose
- This is a single‐service Node.js/Express RESTful backend API for an e-waste marketplace.
- Its primary purpose is to handle user authentication, admin operations, listings of electronic waste, reviews, and transaction management.

##### File structure
- Top‐level files:
- app.js – application entry point, sets up Express, loads routes & middleware
- package.json – dependencies (Express, Mongoose, Redis, etc.)
- env_format.txt – environment variable template
- src/config – database (MongoDB via Mongoose), Redis cache, temp settings
- src/controllers – HTTP handlers for each domain (auth, user, admin, e-waste, review, transaction)
- src/routes/api – routers that map URL paths to controllers
- src/models – Mongoose schemas (users, admin, organizations, e-waste listings, reviews, transactions)
- src/middlewares – authentication, role‐based access, input‐validation error handling, ownership checks
- src/services / src/utils – auxiliary functions (token generation, email/OTP workflows, Redis utilities, password hashing)
- src/validators – request‐payload validation logic

##### Insights from README
- Local setup instructions: uses nodemon to launch app.js
- API documentation hosted on Postman (defines endpoints and payloads)

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Clients and Entry
    subgraph "Clients"
        Client["Web/Mobile Client"]:::external
    end
    Client -->|"HTTP Request"| LB["API Gateway / Load Balancer"]:::compute

    %% Express App Container
    subgraph "Express App"
        Entry["app.js"]:::compute

        subgraph "Routes Layer"
            APIAgg["API Routes Aggregator"]:::compute
            AuthR["Auth Routes"]:::compute
            UserR["User Routes"]:::compute
            AdminR["Admin Routes"]:::compute
            EwasteR["E-Waste Routes"]:::compute
            ReviewR["Review Routes"]:::compute
            TransR["Transaction Routes"]:::compute
        end

        subgraph "Middleware Layer"
            AuthM["Auth Middleware"]:::compute
            RoleM["Role Check Middleware"]:::compute
            ValErrM["Validation Error Handler"]:::compute
            OwnM["Ownership Check Middleware"]:::compute
        end

        subgraph "Controller Layer"
            AuthC["Auth Controller"]:::compute
            UserC["User Controller"]:::compute
            AdminC["Admin Controller"]:::compute
            EwasteC["E-Waste Controller"]:::compute
            ReviewC["Review Controller"]:::compute
            TransC["Transaction Controller"]:::compute
        end

        subgraph "Service & Utility Layer"
            TokenU["JWT Token Generation Utility"]:::compute
            SendOTP["OTP Email Sender Utility"]:::compute
            VerifyOTP["OTP Verification Utility"]:::compute
            HashU["Password Hashing Utility"]:::compute
            RedisU["Redis Utilities"]:::compute
        end

        subgraph "Data Model Layer"
            UserM["User Model"]:::persistent
            AdminM["Admin Model"]:::persistent
            OrgM["Organization Model"]:::persistent
            ListingM["E-Waste Listings Model"]:::persistent
            ReviewM["Review Model"]:::persistent
            TransM["Transactions Model"]:::persistent
        end

        Entry --> APIAgg
        APIAgg --> AuthR
        APIAgg --> UserR
        APIAgg --> AdminR
        APIAgg --> EwasteR
        APIAgg --> ReviewR
        APIAgg --> TransR

        AuthR --> AuthM
        UserR --> AuthM
        AdminR --> AuthM
        EwasteR --> AuthM
        ReviewR --> AuthM
        TransR --> AuthM

        AuthR --> ValErrM
        UserR --> ValErrM
        AdminR --> ValErrM
        EwasteR --> ValErrM
        ReviewR --> ValErrM
        TransR --> ValErrM

        AdminR --> RoleM
        EwasteR --> OwnM
        ReviewR --> OwnM
        TransR --> OwnM

        AuthM --> AuthC
        ValErrM --> AuthC
        RoleM --> AdminC
        OwnM --> EwasteC
        OwnM --> ReviewC
        OwnM --> TransC

        UserR --> UserC

        AuthC --> TokenU
        AuthC --> SendOTP
        AuthC --> VerifyOTP
        UserC --> HashU
        AdminC --> TokenU
        EwasteC --> RedisU
        ReviewC --> RedisU
        TransC --> RedisU

        AuthC --> UserM
        UserC --> UserM
        AdminC --> AdminM
        EwasteC --> ListingM
        ReviewC --> ReviewM
        TransC --> TransM

        TokenU --> RedisU
        RedisU --> RedisCache["Redis Cache"]:::cache
        UserM --> MongoDB["MongoDB"]:::persistent
        AdminM --> MongoDB
        OrgM --> MongoDB
        ListingM --> MongoDB
        ReviewM --> MongoDB
        TransM --> MongoDB

        SendOTP --> Email["External Email Service"]:::external
        VerifyOTP --> Email
    end

    LB --> Entry

    %% Configuration
    subgraph "Configuration"
        DBconf["db.js"]:::compute
        RedisConf["redis.js"]:::compute
        TempConf["temp.js"]:::compute
        EnvFile["env_format.txt"]:::external
        PackageJson["package.json"]:::compute
    end

    DBconf --> Entry
    RedisConf --> Entry
    TempConf --> Entry
    EnvFile --> Entry
    PackageJson --> Entry

    %% Click Events
    click Entry "https://github.com/utsav-patell/googlesolutions_backend_public/blob/master/app.js"
    click EnvFile "https://github.com/utsav-patell/googlesolutions_backend_public/blob/master/env_format.txt"
    click PackageJson "https://github.com/utsav-patell/googlesolutions_backend_public/blob/master/package.json"
    click DBconf "https://github.com/utsav-patell/googlesolutions_backend_public/blob/master/src/config/db.js"
    click RedisConf "https://github.com/utsav-patell/googlesolutions_backend_public/blob/master/src/config/redis.js"
    click TempConf "https://github.com/utsav-patell/googlesolutions_backend_public/blob/master/src/config/temp.js"
    click AuthC "https://github.com/utsav-patell/googlesolutions_backend_public/blob/master/src/controllers/auth-controller.js"
    click UserC "https://github.com/utsav-patell/googlesolutions_backend_public/blob/master/src/controllers/user-controller.js"
    click AdminC "https://github.com/utsav-patell/googlesolutions_backend_public/blob/master/src/controllers/admin-controller.js"
    click EwasteC "https://github.com/utsav-patell/googlesolutions_backend_public/blob/master/src/controllers/eWaste-controller.js"
    click ReviewC "https://github.com/utsav-patell/googlesolutions_backend_public/blob/master/src/controllers/review-controller.js"
    click TransC "https://github.com/utsav-patell/googlesolutions_backend_public/blob/master/src/controllers/transaction-controller.js"
    click AuthM "https://github.com/utsav-patell/googlesolutions_backend_public/blob/master/src/middlewares/authenticate-user.js"
    click RoleM "https://github.com/utsav-patell/googlesolutions_backend_public/blob/master/src/middlewares/role-check.js"
    click ValErrM "https://github.com/utsav-patell/googlesolutions_backend_public/blob/master/src/middlewares/handle-validation-errors.js"
    click OwnM "https://github.com/utsav-patell/googlesolutions_backend_public/blob/master/src/middlewares/ownership-check.js"
    click UserM "https://github.com/utsav-patell/googlesolutions_backend_public/blob/master/src/models/users.js"
    click AdminM "https://github.com/utsav-patell/googlesolutions_backend_public/blob/master/src/models/admin.js"
    click OrgM "https://github.com/utsav-patell/googlesolutions_backend_public/blob/master/src/models/organizations.js"
    click ListingM "https://github.com/utsav-patell/googlesolutions_backend_public/blob/master/src/models/E-waste-listings.js"
    click ReviewM "https://github.com/utsav-patell/googlesolutions_backend_public/blob/master/src/models/review.js"
    click TransM "https://github.com/utsav-patell/googlesolutions_backend_public/blob/master/src/models/transactions.js"
    click APIAgg "https://github.com/utsav-patell/googlesolutions_backend_public/blob/master/src/routes/api/api-routes.js"
    click AuthR "https://github.com/utsav-patell/googlesolutions_backend_public/blob/master/src/routes/api/auth-routes.js"
    click UserR "https://github.com/utsav-patell/googlesolutions_backend_public/blob/master/src/routes/api/users-routes.js"
    click AdminR "https://github.com/utsav-patell/googlesolutions_backend_public/blob/master/src/routes/api/admin-routes.js"
    click EwasteR "https://github.com/utsav-patell/googlesolutions_backend_public/blob/master/src/routes/api/eWaste-routes.js"
    click ReviewR "https://github.com/utsav-patell/googlesolutions_backend_public/blob/master/src/routes/api/review-routes.js"
    click TransR "https://github.com/utsav-patell/googlesolutions_backend_public/blob/master/src/routes/api/transaction-routes.js"
    click TokenU "https://github.com/utsav-patell/googlesolutions_backend_public/blob/master/src/utils/generate-tokens.js"
    click SendOTP "https://github.com/utsav-patell/googlesolutions_backend_public/blob/master/src/utils/mails/send-otp.js"
    click VerifyOTP "https://github.com/utsav-patell/googlesolutions_backend_public/blob/master/src/utils/mails/verify-otp.js"
    click HashU "https://github.com/utsav-patell/googlesolutions_backend_public/blob/master/src/utils/password-utils.js"
    click RedisU "https://github.com/utsav-patell/googlesolutions_backend_public/blob/master/src/utils/redis-utils.js"

    %% Styles
    classDef compute fill:#cce5ff,stroke:#333,stroke-width:1px
    classDef persistent fill:#d4edda,stroke:#333,stroke-width:1px
    classDef cache fill:#fff3cd,stroke:#333,stroke-width:1px
    classDef external fill:#f8d7da,stroke:#333,stroke-width:1px
```
