# marcolinolucas/ecoleta-api architecture

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

- Interactive diagram: https://gitdiagram.com/marcolinolucas/ecoleta-api
- Repository: https://github.com/marcolinolucas/ecoleta-api

## Overview

##### Main Components

a. External Layer:
- Client Applications (Web & Mobile)
- File Storage System (for uploads)
- Database (SQLite3)

b. API Layer Components:
- Server (Express.js)
- Routes Layer
- Controllers Layer
- Database Layer
- Middleware Layer
- Validation Layer

##### Detailed Architecture Breakdown

**[Client Layer]**

- ▼
**[API Gateway Layer]**

**[Middleware Layer] ─────────────┐**

**[Routes Layer]                 │**

**[Validation Layer] ────────┐  │**

**[Controllers Layer]        │  │**

**[Database Layer] ◄────────┘  │**

**[File Storage] ◄────────────┘**

##### Component Details

a. Routes Layer (src/routes/):
- itemsRoutes
- pointsRoutes

b. Controllers Layer (src/controllers/):
- ItemsController
- PointsController

c. Database Layer (src/database/):
- Migrations
- Seeds
- Connection

d. Validation Layer (src/validators/):
- itemsValidator
- pointsValidator

##### Important Flows to Highlight

a. Authentication Flow:
- Request → Middleware → Validation → Controller → Response

b. Data Flow:
- Controller → Database → Response
- File Upload → Multer → Storage → Database Reference

##### Technical Stack Callouts

- Node.js + TypeScript
- Express.js framework
- Knex.js Query Builder
- SQLite3 Database
- Jest Testing Framework
- Multer File Handling

##### Additional Elements

- Error handling flows
- Environment configuration
- Testing boundaries
- Where TypeScript interfaces are used

This architecture represents a typical MVC pattern with additional layers for validation and middleware, which is appropriate for this type of API service.

## Diagram (Mermaid)

```mermaid
flowchart TB
    subgraph Client
        WEB[Web Client]:::client
        MOB[Mobile Client]:::client
    end

    subgraph API
        SERVER["Server (Express)"]:::server
        click SERVER "https://github.com/marcolinolucas/ecoleta-api/blob/master/src/server.ts"
        
        subgraph Routes
            ITEMS_ROUTE["Items Routes"]:::route
            POINTS_ROUTE["Points Routes"]:::route
            click ITEMS_ROUTE "https://github.com/marcolinolucas/ecoleta-api/blob/master/src/routes/itemsRoutes.ts"
            click POINTS_ROUTE "https://github.com/marcolinolucas/ecoleta-api/blob/master/src/routes/pointsRoutes.ts"
        end

        subgraph Middleware
            AUTH["Authentication"]:::middleware
            MULTER["File Upload (Multer)"]:::middleware
            click MULTER "https://github.com/marcolinolucas/ecoleta-api/blob/master/src/configs/multerConfig.ts"
        end

        subgraph Validation
            ITEMS_VAL["Items Validator"]:::validation
            POINTS_VAL["Points Validator"]:::validation
            click ITEMS_VAL "https://github.com/marcolinolucas/ecoleta-api/blob/master/src/validators/itemsValidator.ts"
            click POINTS_VAL "https://github.com/marcolinolucas/ecoleta-api/blob/master/src/validators/pointsValidator.ts"
        end

        subgraph Controllers
            ITEMS_CTRL["Items Controller"]:::controller
            POINTS_CTRL["Points Controller"]:::controller
            click ITEMS_CTRL "https://github.com/marcolinolucas/ecoleta-api/blob/master/src/controllers/ItemsController.ts"
            click POINTS_CTRL "https://github.com/marcolinolucas/ecoleta-api/blob/master/src/controllers/PointsController.ts"
        end
    end

    subgraph Storage
        DB[(SQLite3 Database)]:::database
        FILES[("File Storage")]:::storage
        click DB "https://github.com/marcolinolucas/ecoleta-api/tree/master/src/database"
        click FILES "https://github.com/marcolinolucas/ecoleta-api/tree/master/uploads"
    end

    subgraph Testing
        TESTS["Test Suite"]:::test
        click TESTS "https://github.com/marcolinolucas/ecoleta-api/tree/master/tests"
    end

    %% Connections
    WEB & MOB --> SERVER
    SERVER --> ITEMS_ROUTE & POINTS_ROUTE
    ITEMS_ROUTE & POINTS_ROUTE --> AUTH
    AUTH --> ITEMS_VAL & POINTS_VAL
    ITEMS_VAL --> ITEMS_CTRL
    POINTS_VAL --> POINTS_CTRL
    ITEMS_CTRL & POINTS_CTRL --> DB
    MULTER --> FILES
    TESTS -.-> SERVER

    %% Styles
    classDef client fill:#2196F3,stroke:#1565C0,color:white
    classDef server fill:#4CAF50,stroke:#2E7D32,color:white
    classDef route fill:#8BC34A,stroke:#558B2F,color:white
    classDef middleware fill:#9C27B0,stroke:#6A1B9A,color:white
    classDef validation fill:#FF9800,stroke:#EF6C00,color:white
    classDef controller fill:#F44336,stroke:#C62828,color:white
    classDef database fill:#795548,stroke:#4E342E,color:white
    classDef storage fill:#607D8B,stroke:#37474F,color:white
    classDef test fill:#9E9E9E,stroke:#424242,color:white

    %% Legend
    subgraph Legend
        L1[Client]:::client
        L2[Server]:::server
        L3[Routes]:::route
        L4[Middleware]:::middleware
        L5[Validation]:::validation
        L6[Controllers]:::controller
        L7[Database]:::database
        L8[Storage]:::storage
        L9[Testing]:::test
    end
```
