# aklesh-dev/streamly architecture

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

- Interactive diagram: https://gitdiagram.com/aklesh-dev/streamly
- Repository: https://github.com/aklesh-dev/streamly

## Overview

##### Project type and purpose
- From the file tree and README, we see two sibling folders (“admin service” and “userServices”), each a Node.js+TypeScript REST API with its own src→dist build pipeline.
- This is a small microservices‐style backend: one service handles “admin” operations, the other handles “user” operations. Both use layered code (routes, controllers, middleware, database config).

##### File structure
- Top level:
- “admin service”
- “userServices”
- Inside each:
- src/ – TypeScript source files (route.ts, controller.ts, middleware, lib/db.config.ts, etc.)
- tsconfig.json – TypeScript compiler settings
- package.json – service dependencies / scripts
- dist/ – compiled JavaScript output mirroring src/ layers
- Common architectural pattern in each service:
- Routes → Controllers → (Models/lib) → DB
- Middleware chain for error handling (TryCatch), authentication (auth.middleware), and file uploads (multer.middleware + dataUri)

##### README for additional insights
- It only documents how to initialize TypeScript, compile (npx tsc), and run via ts-node.

##### Elements
- Clear, human‐readable labels for each component (e.g., “Auth Middleware,” “User Controller”).
- Annotations for build steps (TS compile) and deployment artifacts (dist/, Docker container if applicable).

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Clients
    Client["Client (Web/Mobile)"]:::external

    %% Admin Service
    subgraph "Admin Service" 
        direction TB
        AdminIndex["Entry Point\nsrc/index.ts"]:::microservice
        AdminRoute["Routes\nsrc/route.ts"]:::microservice
        AdminMiddlewareAuth["Auth Middleware\nsrc/middleware/auth.middleware.ts"]:::middleware
        AdminMiddlewareError["Error Handler\nsrc/middleware/TryCatch.ts"]:::middleware
        AdminMiddlewareUpload["File Upload Middleware\nsrc/middleware/multer.middleware.ts"]:::middleware
        AdminController["Controller\nsrc/controller.ts"]:::microservice
        AdminLibDB["DB Config\nsrc/lib/db.config.ts"]:::lib
        AdminLibDataUri["Data-URI Helper\nsrc/lib/dataUri.ts"]:::lib
    end

    %% Admin DB and External Storage
    AdminDB["Admin Database\n(PostgreSQL/MongoDB)"]:::database
    S3["External Storage (S3/CDN)"]:::external

    %% User Service
    subgraph "User Service"
        direction TB
        UserIndex["Entry Point\nsrc/index.ts"]:::microservice
        UserRoute["Routes\nsrc/route.ts"]:::microservice
        UserMiddlewareAuth["Auth Middleware\nsrc/middleware/auth.middleware.ts"]:::middleware
        UserMiddlewareError["Error Handler\nsrc/middleware/TryCatch.ts"]:::middleware
        UserController["Controller\nsrc/controller.ts"]:::microservice
        UserModel["Domain Model\nsrc/Model.ts"]:::lib
        UserLibDB["DB Config\nsrc/lib/db.confit.ts"]:::lib
    end

    %% User DB
    UserDB["User Database\n(PostgreSQL/MongoDB)"]:::database

    %% Connections
    Client -->|HTTP Request| AdminIndex
    AdminIndex --> AdminRoute
    AdminRoute --> AdminMiddlewareAuth
    AdminMiddlewareAuth --> AdminMiddlewareError
    AdminMiddlewareError --> AdminMiddlewareUpload
    AdminMiddlewareUpload --> AdminController
    AdminController --> AdminLibDB
    AdminController --> AdminLibDataUri
    AdminLibDB --> AdminDB
    AdminLibDataUri --> S3

    Client -->|HTTP Request| UserIndex
    UserIndex --> UserRoute
    UserRoute --> UserMiddlewareAuth
    UserMiddlewareAuth --> UserMiddlewareError
    UserMiddlewareError --> UserController
    UserController --> UserLibDB
    UserController --> UserModel
    UserLibDB --> UserDB

    %% Click Events Admin Service
    click AdminIndex "https://github.com/aklesh-dev/streamly/blob/main/admin service/src/index.ts"
    click AdminRoute "https://github.com/aklesh-dev/streamly/blob/main/admin service/src/route.ts"
    click AdminController "https://github.com/aklesh-dev/streamly/blob/main/admin service/src/controller.ts"
    click AdminLibDB "https://github.com/aklesh-dev/streamly/blob/main/admin service/src/lib/db.config.ts"
    click AdminLibDataUri "https://github.com/aklesh-dev/streamly/blob/main/admin service/src/lib/dataUri.ts"
    click AdminMiddlewareError "https://github.com/aklesh-dev/streamly/blob/main/admin service/src/middleware/TryCatch.ts"
    click AdminMiddlewareAuth "https://github.com/aklesh-dev/streamly/blob/main/admin service/src/middleware/auth.middleware.ts"
    click AdminMiddlewareUpload "https://github.com/aklesh-dev/streamly/blob/main/admin service/src/middleware/multer.middleware.ts"

    %% Click Events Admin Dist
    click AdminIndex "https://github.com/aklesh-dev/streamly/blob/main/admin service/dist/index.js"
    click AdminRoute "https://github.com/aklesh-dev/streamly/blob/main/admin service/dist/route.js"
    click AdminController "https://github.com/aklesh-dev/streamly/blob/main/admin service/dist/controller.js"
    click AdminLibDB "https://github.com/aklesh-dev/streamly/blob/main/admin service/dist/lib/db.config.js"
    click AdminLibDataUri "https://github.com/aklesh-dev/streamly/blob/main/admin service/dist/lib/datauri.js"
    click AdminMiddlewareError "https://github.com/aklesh-dev/streamly/blob/main/admin service/dist/middleware/TryCatch.js"
    click AdminMiddlewareAuth "https://github.com/aklesh-dev/streamly/blob/main/admin service/dist/middleware/auth.middleware.js"
    click AdminMiddlewareUpload "https://github.com/aklesh-dev/streamly/blob/main/admin service/dist/middleware/multer.middleware.js"

    %% Click Events User Service
    click UserIndex "https://github.com/aklesh-dev/streamly/blob/main/userServices/src/index.ts"
    click UserRoute "https://github.com/aklesh-dev/streamly/blob/main/userServices/src/route.ts"
    click UserController "https://github.com/aklesh-dev/streamly/blob/main/userServices/src/controller.ts"
    click UserModel "https://github.com/aklesh-dev/streamly/blob/main/userServices/src/Model.ts"
    click UserLibDB "https://github.com/aklesh-dev/streamly/blob/main/userServices/src/lib/db.confit.ts"
    click UserMiddlewareError "https://github.com/aklesh-dev/streamly/blob/main/userServices/src/middleware/TryCatch.ts"
    click UserMiddlewareAuth "https://github.com/aklesh-dev/streamly/blob/main/userServices/src/middleware/auth.middleware.ts"

    %% Click Events User Dist
    click UserIndex "https://github.com/aklesh-dev/streamly/blob/main/userServices/dist/index.js"
    click UserRoute "https://github.com/aklesh-dev/streamly/blob/main/userServices/dist/route.js"
    click UserController "https://github.com/aklesh-dev/streamly/blob/main/userServices/dist/controller.js"
    click UserModel "https://github.com/aklesh-dev/streamly/blob/main/userServices/dist/Model.js"
    click UserLibDB "https://github.com/aklesh-dev/streamly/blob/main/userServices/dist/lib/db.confit.js"
    click UserMiddlewareError "https://github.com/aklesh-dev/streamly/blob/main/userServices/dist/middleware/TryCatch.js"
    click UserMiddlewareAuth "https://github.com/aklesh-dev/streamly/blob/main/userServices/dist/middleware/auth.middleware.js"

    %% Styles
    classDef microservice fill:#E0F7FA,stroke:#006064,color:#004D40
    classDef middleware fill:#FFF9C4,stroke:#F57F17,color:#E65100
    classDef lib fill:#E8F5E9,stroke:#1B5E20,color:#2E7D32
    classDef database fill:#C8E6C9,stroke:#2E7D32,color:#1B5E20,stroke-width:2px
    classDef external fill:#FFE0B2,stroke:#E65100,color:#BF360C
```
