# umutkarakas34/ecommerce-project architecture

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

- Interactive diagram: https://gitdiagram.com/umutkarakas34/ecommerce-project
- Repository: https://github.com/umutkarakas34/ecommerce-project

## Overview

##### Project type and purpose
- This is a Node.js/Express backend for an e-commerce platform.
- It exposes RESTful HTTP APIs for users, sellers, and admins.
- It uses Sequelize ORM to manage a MySQL database.

##### File structure
- Top‐level directory: eCommerce-backend
– app.js: entry point, wires middleware, routes, DB sync, static files, and server startup.
– routes/: defines three API routers: /admin, /seller, /user.
– controllers/: houses business logic per role (adminController, sellerController, userController).
– middlewares/: authentication layer (AuthMiddleware).
– models/: Sequelize model definitions (User, Product, Order, Cart, etc.) plus relationship.js that establishes associations.
– utility/db.js: sets up Sequelize connection to MySQL.
– public/: static assets served at /public.
– .env: environment variables for DB credentials, JWT secrets, etc.

##### README for additional technical insights
- Uses Express, Sequelize, MySQL.
- Enables CORS, JSON/body-parser middleware, session support, dotenv for config.
- Routes are mounted at /admin, /seller, /user.
- Database sync is optionally triggered in app.js.
- No external microservices; pure monolithic API server.

a. Main components
1. HTTP API Server (Express App)
– Route Layer (/admin, /seller, /user)
– Controller Layer (adminController, sellerController, userController)
– Middleware Layer (AuthMiddleware, cors, body-parsers, session)
2. ORM/Data Access Layer
– Sequelize models & relationship definitions
– utility/db.js (Sequelize instance)
3. Database
– MySQL instance (remote or local)
4. Static asset server
– Serving public/ via express.static
5. Configuration
– .env, dotenv module
b. Relationships & interactions
– Client (frontend or API consumer) → HTTP request → Express Route → AuthMiddleware → Controller → Sequelize Model → MySQL.
– Controller may invoke multiple models (e.g., orderController uses Order, OrderItem, Product).
– Sequelize defines associations in relationship.js, enabling JOINs.
– app.js wires routes and middleware, serves static files on /public.
c. Architectural patterns & design principles
– Layered (Presentation → Controller/Service → Data Access → Persistence)
– MVC-style separation (Express routes/controllers, Sequelize models)
– Single monolithic service (no microservices).
d. Key technologies/frameworks
– Node.js runtime
– Express (web framework)
– Sequelize (ORM)
– MySQL (relational database)
– Middleware: cors, body-parser, express-session, dotenv

##### Detail is key
– Route definitions (/admin, /seller, /user)
– Controller modules
– AuthMiddleware
– ORM/Sequelize configuration
– Database
– Static file serving
- Environment/config (.env) as a config block that feeds into utility/db.js and express-session setup.
- If helpful, annotate sample endpoint flows (e.g., POST /user/create-order → UserController.createOrder() → Order & OrderItem models → MySQL).

## Diagram (Mermaid)

```mermaid
flowchart TB
    Client["Frontend / API Consumer"]:::external
    subgraph "API Layer"
        APIServer["Express App (app.js)"]:::server
        subgraph "Route Layer"
            AdminRoute["/admin Router"]:::server
            SellerRoute["/seller Router"]:::server
            UserRoute["/user Router"]:::server
        end
        AuthMW["AuthMiddleware"]:::middleware
        CORS["cors / body-parser / express-session"]:::middleware
    end

    subgraph "Business Logic Layer"
        AdminCtrl["AdminController"]:::server
        SellerCtrl["SellerController"]:::server
        UserCtrl["UserController"]:::server
    end

    subgraph "Data Access Layer"
        DBUtil["Sequelize Connection (utility/db.js)"]:::server
        subgraph "Sequelize Models"
            ModelsDir["Models Directory"]:::models
            RelDef["relationship.js"]:::models
        end
    end

    Static["Static Assets Server (/public)"]:::static
    Config["Environment Config (.env)"]:::config
    DB["MySQL Database"]:::database

    %% Connections
    Client -->|"HTTP Request"| APIServer
    APIServer -->|"mounts"| AdminRoute
    APIServer -->|"mounts"| SellerRoute
    APIServer -->|"mounts"| UserRoute
    AdminRoute -->|passes through| AuthMW
    SellerRoute -->|passes through| AuthMW
    UserRoute -->|passes through| AuthMW
    APIServer -->|uses| CORS
    AuthMW -->|calls| AdminCtrl
    AuthMW -->|calls| SellerCtrl
    AuthMW -->|calls| UserCtrl
    AdminCtrl -->|uses| ModelsDir
    SellerCtrl -->|uses| ModelsDir
    UserCtrl -->|uses| ModelsDir
    ModelsDir -->|associations| RelDef
    RelDef -->|connects via| DBUtil
    DBUtil -->|connects to| DB
    APIServer -->|serves static| Static
    Config -->|provides env| DBUtil
    Config -->|provides env| APIServer

    %% Click Events
    click APIServer "https://github.com/umutkarakas34/ecommerce-project/blob/main/eCommerce-backend/app.js"
    click AdminRoute "https://github.com/umutkarakas34/ecommerce-project/blob/main/eCommerce-backend/routes/admin.js"
    click SellerRoute "https://github.com/umutkarakas34/ecommerce-project/blob/main/eCommerce-backend/routes/seller.js"
    click UserRoute "https://github.com/umutkarakas34/ecommerce-project/blob/main/eCommerce-backend/routes/user.js"
    click AdminCtrl "https://github.com/umutkarakas34/ecommerce-project/blob/main/eCommerce-backend/controllers/adminController.js"
    click SellerCtrl "https://github.com/umutkarakas34/ecommerce-project/blob/main/eCommerce-backend/controllers/sellerController.js"
    click UserCtrl "https://github.com/umutkarakas34/ecommerce-project/blob/main/eCommerce-backend/controllers/userController.js"
    click AuthMW "https://github.com/umutkarakas34/ecommerce-project/blob/main/eCommerce-backend/middlewares/AuthMiddleware.js"
    click ModelsDir "https://github.com/umutkarakas34/ecommerce-project/tree/main/eCommerce-backend/models/"
    click RelDef "https://github.com/umutkarakas34/ecommerce-project/blob/main/eCommerce-backend/models/relationship.js"
    click DBUtil "https://github.com/umutkarakas34/ecommerce-project/blob/main/eCommerce-backend/utility/db.js"
    click Static "https://github.com/umutkarakas34/ecommerce-project/tree/main/eCommerce-backend/public/"
    click Config "https://github.com/umutkarakas34/ecommerce-project/blob/main/eCommerce-backend/.env"

    %% Styles
    classDef server fill:#D0E8FF,stroke:#0366D6,color:#0366D6;
    classDef middleware fill:#E6FFED,stroke:#28A745,color:#28A745;
    classDef models fill:#FFF5E6,stroke:#D97706,color:#D97706;
    classDef database fill:#EDEFF1,stroke:#636466,color:#636466;
    classDef static fill:#F3E8FF,stroke:#8B5CF6,color:#8B5CF6;
    classDef config fill:#FEF3C7,stroke:#CA8A04,color:#CA8A04;
    classDef external fill:#F0F0F0,stroke:#888888,color:#555555;
```
