# imobify/imobify-backend architecture

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

- Interactive diagram: https://gitdiagram.com/imobify/imobify-backend
- Repository: https://github.com/imobify/imobify-backend

## Overview

##### Main System Components

a) API Layer
- Auth Module
- Real Estate Module
- User Module
- Favorite Module
- Lead Module

b) Infrastructure
- PostgreSQL Database with PostGIS extension
- Cloudinary Service for image management
- Prisma ORM layer

##### Architectural Pattern Representation

a) Core Layers:
- Controllers (API endpoints)
- Services (Business logic)
- DTOs (Data Transfer Objects)
- Guards & Interceptors
- Database layer (Prisma)

b) Module Organization:
**API Controllers**
- ↓
**Guards/Interceptors**
- ↓
**Services Layer**
- ↓
**Prisma Service**
- ↓
**PostgreSQL + PostGIS**

##### Key Relationships to Highlight

- Auth flow: JWT strategy and guards protecting routes
- Image handling: Connection between RealEstate/User modules and Cloudinary
- Geospatial queries: RealEstate module interaction with PostGIS
- Database relationships: User ↔ RealEstate ↔ Favorites

##### Detailed Component Breakdown

**External Services Layer**
- Cloudinary (Image Storage)
- PostGIS (Geospatial Processing)

**API Layer**
- Auth
- SignIn
- SignUp
- RealEstate
- CRUD Operations
- Geospatial Queries
- Users
- Profile Management
- Avatar Handling
- Favorites
- Leads

**Middleware Layer**
- JWT Guard
- User ID Check Interceptor
- Type ID Check Interceptor

**Data Layer**
- Prisma ORM
- PostgreSQL + PostGIS

##### Testing Infrastructure

- E2E test setup
- Test database connections
- Jest configuration

Remember to maintain a balance between detail and clarity, focusing on the architectural decisions that make this real estate application unique, particularly its geospatial features and image handling capabilities.

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph External["External Services"]
        Cloud[("Cloudinary")]:::external
        PostGIS[("PostGIS")]:::external
    end

    subgraph API["API Layer"]
        subgraph Auth["Auth Module"]
            AuthC["Auth Controller"]:::controller
            AuthS["Auth Service"]:::service
            JWT["JWT Strategy"]:::middleware
        end

        subgraph RealEstate["Real Estate Module"]
            REC["Real Estate Controller"]:::controller
            RES["Real Estate Service"]:::service
        end

        subgraph User["User Module"]
            UC["User Controller"]:::controller
            US["User Service"]:::service
        end

        subgraph Favorite["Favorite Module"]
            FC["Favorite Controller"]:::controller
            FS["Favorite Service"]:::service
        end

        subgraph Lead["Lead Module"]
            LC["Lead Controller"]:::controller
            LS["Lead Service"]:::service
        end
    end

    subgraph Middleware["Middleware Layer"]
        JWTGuard["JWT Guard"]:::middleware
        UserIDCheck["User ID Check"]:::middleware
        TypeIDCheck["Type ID Check"]:::middleware
    end

    subgraph Data["Data Layer"]
        Prisma["Prisma ORM"]:::database
        PostgreSQL[("PostgreSQL")]:::database
    end

    %% Connections
    AuthC --> AuthS
    REC --> RES
    UC --> US
    FC --> FS
    LC --> LS

    %% Middleware connections
    JWTGuard -.-> AuthC
    JWTGuard -.-> REC
    JWTGuard -.-> UC
    JWTGuard -.-> FC
    JWTGuard -.-> LC

    UserIDCheck -.-> REC
    UserIDCheck -.-> UC
    TypeIDCheck -.-> REC

    %% Service to Database connections
    AuthS --> Prisma
    RES --> Prisma
    US --> Prisma
    FS --> Prisma
    LS --> Prisma
    Prisma --> PostgreSQL
    PostgreSQL --- PostGIS

    %% External service connections
    RES --> Cloud
    US --> Cloud

    %% Click events
    click AuthC "https://github.com/imobify/imobify-backend/blob/main/src/auth/auth.controller.ts"
    click AuthS "https://github.com/imobify/imobify-backend/blob/main/src/auth/auth.service.ts"
    click JWT "https://github.com/imobify/imobify-backend/tree/main/src/auth/strategy/"
    click REC "https://github.com/imobify/imobify-backend/blob/main/src/models/realEstate/real-estate.controller.ts"
    click RES "https://github.com/imobify/imobify-backend/blob/main/src/models/realEstate/real-estate.service.ts"
    click UC "https://github.com/imobify/imobify-backend/blob/main/src/models/user/user.controller.ts"
    click US "https://github.com/imobify/imobify-backend/blob/main/src/models/user/user.service.ts"
    click FC "https://github.com/imobify/imobify-backend/blob/main/src/models/favorite/favorite.controller.ts"
    click FS "https://github.com/imobify/imobify-backend/blob/main/src/models/favorite/favorite.service.ts"
    click LC "https://github.com/imobify/imobify-backend/blob/main/src/models/lead/lead.controller.ts"
    click LS "https://github.com/imobify/imobify-backend/blob/main/src/models/lead/lead.service.ts"
    click JWTGuard "https://github.com/imobify/imobify-backend/blob/main/src/auth/guard/jwt.guard.ts"
    click UserIDCheck "https://github.com/imobify/imobify-backend/blob/main/src/auth/interceptor/check-user-id.interceptor.ts"
    click TypeIDCheck "https://github.com/imobify/imobify-backend/blob/main/src/models/shared/interceptors/type-id-check.interceptor.ts"
    click Prisma "https://github.com/imobify/imobify-backend/blob/main/src/shared/prisma/prisma.service.ts"
    click Cloud "https://github.com/imobify/imobify-backend/blob/main/src/shared/image/providers/cloudinary.provider.ts"

    %% Styling
    classDef controller fill:#2196F3,stroke:#1565C0,color:white
    classDef service fill:#4CAF50,stroke:#2E7D32,color:white
    classDef middleware fill:#FFC107,stroke:#FFA000,color:black
    classDef database fill:#90A4AE,stroke:#546E7A,color:white
    classDef external fill:#9C27B0,stroke:#6A1B9A,color:white
```
