# antonysavache/it-incubator-10w architecture

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

- Interactive diagram: https://gitdiagram.com/antonysavache/it-incubator-10w
- Repository: https://github.com/antonysavache/it-incubator-10w

## Overview

##### Project Type and Purpose
- The project is a backend server—likely a REST API—organized by domain (e.g., auth, blogs, comments, posts, users).
- It follows a clean or hexagonal (ports & adapters) architecture style with distinct modules, each separated into API, application (use-cases), domain, and infrastructure layers.
- The “shared” components (DB, middlewares, repositories) indicate common services and utilities that support each domain module.

##### File Structure for Architectural Cues
- Top-Level Structure:
– src folder contains the primary application code.
– Directories such as modules, configs, shared, and testing define major components.
- Each module (auth, blogs, comments, posts, users) has its clear separation:
– API: Controllers, routers, and middlewares for handling HTTP requests.
– Application: Use-case implementations that orchestrate business logic.
– Domain: Entities and interfaces that define core business models and rules.
– Infrastructure: Repositories and external services (like email in auth) that integrate with databases or other systems.
- The shared/infrastructures and shared/models indicate the common dependencies like database connectivity (MongoDB via mongoose) and common data validation or error-handling services.
- Configuration files (e.g., tsconfig.json, vercel.json) and composition files (in src/configs/compositions) reflect how dependencies are wired and settings are configured.

##### Essential Elements
- Each major component should be clearly labeled (e.g., “Auth Module – API Layer”, “Blogs Module – Application”, “Shared DB Connectivity”).
- Legends or notes if necessary, to indicate how the clean architecture is implemented.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Subgraphs for each layer
    subgraph "API Layer"
        AuthAPI["Auth Module - API Layer"]
        BlogsAPI["Blogs Module - API Layer"]
        CommentsAPI["Comments Module - API Layer"]
        PostsAPI["Posts Module - API Layer"]
        UsersAPI["Users Module - API Layer"]
        TestingAPI["Testing Module - API Layer"]
    end

    subgraph "Application Layer"
        AuthApp["Auth Use-Cases"]
        BlogsApp["Blogs Use-Cases"]
        CommentsApp["Comments Use-Cases"]
        PostsApp["Posts Use-Cases"]
        UsersApp["Users Use-Cases"]
    end

    subgraph "Domain Layer"
        AuthDomain["Auth Domain"]
        BlogsDomain["Blogs Domain"]
        CommentsDomain["Comments Domain"]
        PostsDomain["Posts Domain"]
        UsersDomain["Users Domain"]
    end

    subgraph "Infrastructure Layer"
        AuthInfra["Auth Infra (Repositories & Services)"]
        BlogsInfra["Blogs Infra (Repositories & Schemas)"]
        CommentsInfra["Comments Infra (Repositories)"]
        PostsInfra["Posts Infra (Repositories & Schemas)"]
        UsersInfra["Users Infra (Repositories)"]
    end

    subgraph "Shared Components"
        DB["DB Connectivity"]
        Middlewares["Shared Middlewares"]
        CommonModels["Common Models & Validation"]
        JWTUtilities["JWT & Utilities"]
    end

    subgraph "Configuration & Composition"
        ConfigCompose["Configuration & Composition"]
    end

    %% Flow for Auth Module
    AuthAPI -->|"calls"| AuthApp
    AuthApp -->|"executes"| AuthDomain
    AuthDomain -->|"invokes"| AuthInfra

    %% Flow for Blogs Module
    BlogsAPI -->|"calls"| BlogsApp
    BlogsApp -->|"executes"| BlogsDomain
    BlogsDomain -->|"invokes"| BlogsInfra

    %% Flow for Comments Module
    CommentsAPI -->|"calls"| CommentsApp
    CommentsApp -->|"executes"| CommentsDomain
    CommentsDomain -->|"invokes"| CommentsInfra

    %% Flow for Posts Module
    PostsAPI -->|"calls"| PostsApp
    PostsApp -->|"executes"| PostsDomain
    PostsDomain -->|"invokes"| PostsInfra

    %% Flow for Users Module
    UsersAPI -->|"calls"| UsersApp
    UsersApp -->|"executes"| UsersDomain
    UsersDomain -->|"invokes"| UsersInfra

    %% Testing Module registration
    TestingAPI -->|"registeredWith"| ConfigCompose

    %% API Layer uses Shared Middlewares
    AuthAPI -->|"uses"| Middlewares
    BlogsAPI -->|"uses"| Middlewares
    CommentsAPI -->|"uses"| Middlewares
    PostsAPI -->|"uses"| Middlewares
    UsersAPI -->|"uses"| Middlewares
    TestingAPI -->|"uses"| Middlewares

    %% Infrastructure connects to the shared DB
    AuthInfra -->|"connects"| DB
    BlogsInfra -->|"connects"| DB
    CommentsInfra -->|"connects"| DB
    PostsInfra -->|"connects"| DB
    UsersInfra -->|"connects"| DB

    %% Application layer (Auth) utilizes JWT & Utilities
    AuthApp -->|"uses"| JWTUtilities

    %% Configuration wiring to various layers
    ConfigCompose -->|"wires"| AuthAPI
    ConfigCompose -->|"wires"| BlogsAPI
    ConfigCompose -->|"wires"| CommentsAPI
    ConfigCompose -->|"wires"| PostsAPI
    ConfigCompose -->|"wires"| UsersAPI
    ConfigCompose -->|"wires"| AuthApp
    ConfigCompose -->|"wires"| BlogsApp
    ConfigCompose -->|"wires"| CommentsApp
    ConfigCompose -->|"wires"| PostsApp
    ConfigCompose -->|"wires"| UsersApp
    ConfigCompose -->|"wires"| AuthInfra
    ConfigCompose -->|"wires"| BlogsInfra
    ConfigCompose -->|"wires"| CommentsInfra
    ConfigCompose -->|"wires"| PostsInfra
    ConfigCompose -->|"wires"| UsersInfra

    %% Click Events
    click AuthAPI "https://github.com/antonysavache/it-incubator-10w/tree/main/src/modules/auth/api"
    click BlogsAPI "https://github.com/antonysavache/it-incubator-10w/tree/main/src/modules/blogs/api"
    click CommentsAPI "https://github.com/antonysavache/it-incubator-10w/tree/main/src/modules/comments/api"
    click PostsAPI "https://github.com/antonysavache/it-incubator-10w/tree/main/src/modules/posts/api"
    click UsersAPI "https://github.com/antonysavache/it-incubator-10w/tree/main/src/modules/users/api"
    click TestingAPI "https://github.com/antonysavache/it-incubator-10w/tree/main/src/modules/testing/application/api"
    click AuthApp "https://github.com/antonysavache/it-incubator-10w/tree/main/src/modules/auth/application/use-cases"
    click BlogsApp "https://github.com/antonysavache/it-incubator-10w/tree/main/src/modules/blogs/application/use-cases"
    click CommentsApp "https://github.com/antonysavache/it-incubator-10w/tree/main/src/modules/comments/application/use-cases"
    click PostsApp "https://github.com/antonysavache/it-incubator-10w/tree/main/src/modules/posts/application/use-cases"
    click UsersApp "https://github.com/antonysavache/it-incubator-10w/tree/main/src/modules/users/application/use-cases"
    click AuthDomain "https://github.com/antonysavache/it-incubator-10w/tree/main/src/modules/auth/domain"
    click BlogsDomain "https://github.com/antonysavache/it-incubator-10w/tree/main/src/modules/blogs/domain"
    click CommentsDomain "https://github.com/antonysavache/it-incubator-10w/tree/main/src/modules/comments/domain"
    click PostsDomain "https://github.com/antonysavache/it-incubator-10w/tree/main/src/modules/posts/domain"
    click UsersDomain "https://github.com/antonysavache/it-incubator-10w/tree/main/src/modules/users/domain"
    click AuthInfra "https://github.com/antonysavache/it-incubator-10w/tree/main/src/modules/auth/infrastructure"
    click BlogsInfra "https://github.com/antonysavache/it-incubator-10w/tree/main/src/modules/blogs/infrastructure"
    click CommentsInfra "https://github.com/antonysavache/it-incubator-10w/tree/main/src/modules/comments/infrastructure"
    click PostsInfra "https://github.com/antonysavache/it-incubator-10w/tree/main/src/modules/posts/infrastructure"
    click UsersInfra "https://github.com/antonysavache/it-incubator-10w/tree/main/src/modules/users/domain/infrastructures/repositories"
    click DB "https://github.com/antonysavache/it-incubator-10w/tree/main/src/shared/infrastructures/db"
    click Middlewares "https://github.com/antonysavache/it-incubator-10w/tree/main/src/shared/infrastructures/middlewares"
    click CommonModels "https://github.com/antonysavache/it-incubator-10w/tree/main/src/shared/models"
    click JWTUtilities "https://github.com/antonysavache/it-incubator-10w/tree/main/src/shared/services"
    click ConfigCompose "https://github.com/antonysavache/it-incubator-10w/tree/main/src/configs/compositions"

    %% Styles
    classDef api fill:#8ED1FC,stroke:#1F78C1,stroke-width:2px;
    classDef app fill:#B4F0B4,stroke:#2E8B57,stroke-width:2px;
    classDef domain fill:#FFF5BA,stroke:#D4AF37,stroke-width:2px;
    classDef infra fill:#F7C6C7,stroke:#C44C58,stroke-width:2px;
    classDef shared fill:#D7BDE2,stroke:#8E44AD,stroke-width:2px;
    classDef config fill:#CFE2F3,stroke:#2F75B5,stroke-width:2px;

    class AuthAPI,BlogsAPI,CommentsAPI,PostsAPI,UsersAPI,TestingAPI api;
    class AuthApp,BlogsApp,CommentsApp,PostsApp,UsersApp app;
    class AuthDomain,BlogsDomain,CommentsDomain,PostsDomain,UsersDomain domain;
    class AuthInfra,BlogsInfra,CommentsInfra,PostsInfra,UsersInfra infra;
    class DB,Middlewares,CommonModels,JWTUtilities shared;
    class ConfigCompose config;
```
