# areeb0206/trade_backend_test architecture

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

- Interactive diagram: https://gitdiagram.com/areeb0206/trade_backend_test
- Repository: https://github.com/areeb0206/trade_backend_test

## Overview

##### Project type and purpose
- This is a Node.js/Express REST-API backend for a “Trading Journal” platform.
- It exposes both public/user endpoints (under routes/api) and admin endpoints (under routes/adminApi).
- It integrates with external brokers (E*Trade, Questrade, MetaTrader, Kraken, Polygon), Stripe for payments, SnapTrade, Redis (dump.rdb), AWS S3, and MongoDB via Mongoose models.

##### File structure
- Top-level layers:
- config (app/Mongo/third-party credentials)
- routes (API vs. adminApi)
- controllers (one per feature, orchestrating request→response)
- services (business logic, third-party SDK wrappers, CSV upload parsers, report generators)
- models (Mongoose schemas)
- middlewares (JWT auth, role checks, input validation)
- helpers/utils/templates (shared utilities: bcrypt, email, file upload, socket.io)
- Docker-compose and dump.rdb indicate local containerization with Redis (cache/session) and likely MongoDB.

##### Key insights from README
- Minimal README suggests focus on backend logic; actual architecture must be inferred from code organization.

## Diagram (Mermaid)

```mermaid
flowchart TD
    subgraph "Client"
        Client["Client"]:::external
    end

    subgraph "Edge Layer"
        App["Express App"]:::app
        Config["Configuration"]:::config
        PublicAPI["Public API Routes"]:::api
        AdminAPI["Admin API Routes"]:::api
        App --> PublicAPI
        App --> AdminAPI
        App --> Config
    end

    subgraph "Auth & Middleware"
        JWT["JWT Validation"]:::middleware
        Role["Role Check"]:::middleware
        PublicAPI --> JWT --> Role
        AdminAPI --> JWT --> Role
    end

    subgraph "Controller Layer"
        AuthCtrl["Auth Controllers"]:::controller
        TradeCtrl["Trade Controllers"]:::controller
        DashCtrl["Dashboard Controllers"]:::controller
        SnapCtrl["SnapTrade Controllers"]:::controller
        StripeCtrl["Stripe Controllers"]:::controller
        SupportCtrl["Support Controllers"]:::controller
        AdminCtrl["Admin Controllers"]:::controller

        JWT --> AuthCtrl
        JWT --> TradeCtrl
        JWT --> DashCtrl
        JWT --> SnapCtrl
        JWT --> StripeCtrl
        JWT --> SupportCtrl
        Role --> AdminCtrl
    end

    subgraph "Service Layer"
        BrokerSync["Broker Sync Services"]:::service
        Brokers["Broker Helpers"]:::service
        CSV["CSV Upload Parsers"]:::service
        Option["Option Chain Processing"]:::service
        Polygon["Polygon.io Integration"]:::service
        Reports["Report Generators"]:::service
        SnapServ["SnapTrade Helpers"]:::service
        StripeServ["Stripe Helpers"]:::service
        S3Upload["AWS S3 Upload Utility"]:::service
        UploadCSV["Generic File Uploads"]:::service
        TradeServ["Trade Helpers"]:::service
        UtilServ["Shared Utilities"]:::service
        Templates["Invite & OTP Templates"]:::service

        AuthCtrl --> BrokerSync
        AuthCtrl --> UtilServ
        TradeCtrl --> TradeServ
        TradeCtrl --> Brokers
        TradeCtrl --> CSV
        TradeCtrl --> Option
        TradeCtrl --> Polygon
        TradeCtrl --> UtilServ
        SnapCtrl --> SnapServ
        StripeCtrl --> StripeServ
        SupportCtrl --> Templates
        SupportCtrl --> UtilServ
        Reports --> UtilServ
        AdminCtrl --> UtilServ
        AdminCtrl --> S3Upload
        AdminCtrl --> UploadCSV
    end

    subgraph "Data Layer"
        models["Models"]:::model
        Mongo["MongoDB"]:::db
        Redis["Redis"]:::db
        RedisBackup["dump.rdb"]:::db

        PublicAPI --> models
        AdminAPI --> models
        BrokerSync --> models
        TradeServ --> models
        models --> Mongo
        RedisBackup --> Redis
    end

    subgraph "External Services"
        ETrade["E*Trade API"]:::external
        Questrade["Questrade API"]:::external
        MetaTrader["MetaTrader API"]:::external
        Kraken["Kraken API"]:::external
        StripeExt["Stripe"]:::external
        PolygonExt["Polygon.io"]:::external
        SnapTradeExt["SnapTrade"]:::external
        S3["AWS S3"]:::external
        EmailSMS["Email/SMS Providers"]:::external

        BrokerSync --> ETrade
        BrokerSync --> Questrade
        BrokerSync --> MetaTrader
        BrokerSync --> Kraken
        StripeServ --> StripeExt
        Polygon --> PolygonExt
        SnapServ --> SnapTradeExt
        S3Upload --> S3
        Templates --> EmailSMS
    end

    click PublicAPI "https://github.com/areeb0206/trade_backend_test/tree/main/routes/api/"
    click AdminAPI "https://github.com/areeb0206/trade_backend_test/tree/main/routes/adminApi/"
    click App "https://github.com/areeb0206/trade_backend_test/blob/main/index.js"
    click Config "https://github.com/areeb0206/trade_backend_test/blob/main/config/keys.js"
    click JWT "https://github.com/areeb0206/trade_backend_test/blob/main/middlewares/jwt_validation.js"
    click Role "https://github.com/areeb0206/trade_backend_test/blob/main/middlewares/roleCheck.js"
    click AuthCtrl "https://github.com/areeb0206/trade_backend_test/tree/main/controllers/auth/"
    click TradeCtrl "https://github.com/areeb0206/trade_backend_test/tree/main/controllers/trade/"
    click DashCtrl "https://github.com/areeb0206/trade_backend_test/tree/main/controllers/dashboard/"
    click SnapCtrl "https://github.com/areeb0206/trade_backend_test/tree/main/controllers/snaptrade/"
    click StripeCtrl "https://github.com/areeb0206/trade_backend_test/tree/main/controllers/stripe/"
    click SupportCtrl "https://github.com/areeb0206/trade_backend_test/tree/main/controllers/support/"
    click AdminCtrl "https://github.com/areeb0206/trade_backend_test/tree/main/adminController/"
    click BrokerSync "https://github.com/areeb0206/trade_backend_test/tree/main/services/brokerSync/"
    click Brokers "https://github.com/areeb0206/trade_backend_test/tree/main/services/brokers/"
    click CSV "https://github.com/areeb0206/trade_backend_test/tree/main/services/csvUpload/"
    click Option "https://github.com/areeb0206/trade_backend_test/tree/main/services/optionChain/"
    click Polygon "https://github.com/areeb0206/trade_backend_test/tree/main/services/polygon/"
    click Reports "https://github.com/areeb0206/trade_backend_test/tree/main/services/report/"
    click SnapServ "https://github.com/areeb0206/trade_backend_test/tree/main/services/snaptrade/"
    click StripeServ "https://github.com/areeb0206/trade_backend_test/tree/main/services/stripe/"
    click S3Upload "https://github.com/areeb0206/trade_backend_test/blob/main/services/uploadFileToAws.js"
    click UploadCSV "https://github.com/areeb0206/trade_backend_test/blob/main/services/uploadCsv.js"
    click TradeServ "https://github.com/areeb0206/trade_backend_test/tree/main/services/trade/"
    click UtilServ "https://github.com/areeb0206/trade_backend_test/tree/main/services/util/"
    click Templates "https://github.com/areeb0206/trade_backend_test/tree/main/services/templates/"
    click models "https://github.com/areeb0206/trade_backend_test/tree/main/models/"
    click RedisBackup "https://github.com/areeb0206/trade_backend_test/blob/main/dump.rdb"

    classDef app fill:#cfe2f3,stroke:#2196f3,color:#000
    classDef config fill:#e2f0d9,stroke:#4caf50,color:#000
    classDef api fill:#d9ead3,stroke:#6aa84f,color:#000
    classDef middleware fill:#f2f2f2,stroke:#999,color:#000
    classDef controller fill:#c9daf8,stroke:#3d85c6,color:#000
    classDef service fill:#fff2cc,stroke:#f1c232,color:#000
    classDef model fill:#d0e0e3,stroke:#76a5af,color:#000
    classDef db fill:#b6d7a8,stroke:#38761d,color:#000
    classDef external fill:#f9cb9c,stroke:#e69138,color:#000
```
