# sucodelarangela/backend-tech-challenge architecture

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

- Interactive diagram: https://gitdiagram.com/sucodelarangela/backend-tech-challenge
- Repository: https://github.com/sucodelarangela/backend-tech-challenge

## Overview

##### Project type and purpose
- This is a Node.js/Express backend API for a Finance Tech Challenge. It provides REST endpoints for accounts, transactions, statements and user management, backed by MongoDB (via Mongoose). It is consumed by a Backend-for-Frontend (BFF) service and exposes Swagger documentation.

##### File structure
- Top level:
- Dockerfile, package.json/lock, README.md, Postman collection
- src/index.js (application entry point)
- src/routes.js & src/publicRoutes.js (Express routing layers)
- src/swagger.js (Swagger/OpenAPI setup)
- src/controller (Account.js, User.js): Express controller layer
- src/feature: business-service layer (get/save/update/delete functions for Account, Card, Transaction, User)
- src/infra/mongoose: persistence layer
- mongooseConect.js (DB connection)
- modelos.js (schema definitions)
- repository/*Repository.js (data access via repository pattern)
- src/models: domain-model definitions used across the app

##### README for additional insights
- Describes the layered architecture (controller → feature/service → repository → Mongo)
- Lists the primary REST endpoints, Docker instructions and Swagger UI at /docs

##### Elements
→ Client to Router
→ Router to Controller
→ Controller to Service
→ Service to Repository
→ Repository to MongoDB
- Business Logic (Features) in another
- Data Access (Repository/DB) in a third
- Deployment (Docker/Render) as a border or background

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Clients
    Client["Clients (BFF/Postman)"]:::external

    %% Docker Container enclosing the API application and database
    subgraph "Docker Container" 
        direction TB

        %% API Application
        subgraph "API Application" 
            direction TB

            %% Routing Layer
            subgraph "Routing Layer" 
                direction TB
                PublicRoutes["Public Routes"]:::presentation
                ProtectedRoutes["Protected Routes"]:::presentation
            end

            SwaggerUI["Swagger UI (/docs)"]:::docs

            %% Controllers
            subgraph "Controllers" 
                direction TB
                AccountController["Account Controller"]:::presentation
                UserController["User Controller"]:::presentation
            end

            %% Business Logic Services
            subgraph "Services (Features)" 
                direction TB
                GetAccount["getAccount"]:::business
                SaveAccount["saveAccount"]:::business
                GetCard["getCard"]:::business
                SaveCard["saveCard"]:::business
                GetTransaction["getTransaction"]:::business
                SaveTransaction["saveTransaction"]:::business
                UpdateTransaction["updateTransaction"]:::business
                DeleteTransaction["deleteTransaction"]:::business
                GetUser["getUser"]:::business
                SalvarUsuario["salvarUsuario"]:::business
            end

            %% Persistence / Repository Layer
            subgraph "Infra/Mongoose" 
                direction TB
                MongooseConnect["mongooseConnect"]:::data
                Modelos["modelos (Schemas)"]:::data
                subgraph "Repositories" 
                    direction TB
                    AccountRepo["accountRepository"]:::data
                    DetailedAccountRepo["detailedAccountRepository"]:::data
                    CardRepo["cardRepository"]:::data
                    UserRepo["userRepository"]:::data
                end
            end

        end

        %% Database
        MongoDB["MongoDB"]:::db
    end

    %% Relationships
    Client -->|"HTTP Request"| PublicRoutes
    Client -->|"HTTP Request"| ProtectedRoutes
    PublicRoutes -->|"routes.js & publicRoutes.js"| AccountController
    ProtectedRoutes -->|"routes.js"| AccountController
    ProtectedRoutes --> AccountController
    ProtectedRoutes --> UserController

    PublicRoutes --> SwaggerUI
    SwaggerUI --> PublicRoutes

    AccountController -->|"calls"| GetAccount
    AccountController -->|"calls"| SaveAccount
    AccountController -->|"calls"| GetTransaction
    AccountController -->|"calls"| SaveTransaction
    AccountController -->|"calls"| UpdateTransaction
    AccountController -->|"calls"| DeleteTransaction

    UserController --> GetUser
    UserController --> SalvarUsuario

    GetAccount --> AccountRepo
    SaveAccount --> AccountRepo
    GetTransaction --> DetailedAccountRepo
    SaveTransaction --> DetailedAccountRepo
    UpdateTransaction --> DetailedAccountRepo
    DeleteTransaction --> DetailedAccountRepo
    GetCard --> CardRepo
    SaveCard --> CardRepo
    GetUser --> UserRepo
    SalvarUsuario --> UserRepo

    AccountRepo --> MongooseConnect
    CardRepo --> MongooseConnect
    UserRepo --> MongooseConnect
    DetailedAccountRepo --> MongooseConnect
    MongooseConnect --> MongoDB

    %% Click Events
    click Client "https://github.com/sucodelarangela/backend-tech-challenge/blob/main/src/index.js"
    click PublicRoutes "https://github.com/sucodelarangela/backend-tech-challenge/blob/main/src/publicRoutes.js"
    click ProtectedRoutes "https://github.com/sucodelarangela/backend-tech-challenge/blob/main/src/routes.js"
    click SwaggerUI "https://github.com/sucodelarangela/backend-tech-challenge/blob/main/src/swagger.js"
    click AccountController "https://github.com/sucodelarangela/backend-tech-challenge/blob/main/src/controller/Account.js"
    click UserController "https://github.com/sucodelarangela/backend-tech-challenge/blob/main/src/controller/User.js"
    click GetAccount "https://github.com/sucodelarangela/backend-tech-challenge/blob/main/src/feature/Account/getAccount.js"
    click SaveAccount "https://github.com/sucodelarangela/backend-tech-challenge/blob/main/src/feature/Account/saveAccount.js"
    click GetCard "https://github.com/sucodelarangela/backend-tech-challenge/blob/main/src/feature/Card/getCard.js"
    click SaveCard "https://github.com/sucodelarangela/backend-tech-challenge/blob/main/src/feature/Card/saveCard.js"
    click GetTransaction "https://github.com/sucodelarangela/backend-tech-challenge/blob/main/src/feature/Transaction/getTransaction.js"
    click SaveTransaction "https://github.com/sucodelarangela/backend-tech-challenge/blob/main/src/feature/Transaction/saveTransaction.js"
    click UpdateTransaction "https://github.com/sucodelarangela/backend-tech-challenge/blob/main/src/feature/Transaction/updateTransaction.js"
    click DeleteTransaction "https://github.com/sucodelarangela/backend-tech-challenge/blob/main/src/feature/Transaction/deleteTransaction.js"
    click GetUser "https://github.com/sucodelarangela/backend-tech-challenge/blob/main/src/feature/User/getUser.js"
    click SalvarUsuario "https://github.com/sucodelarangela/backend-tech-challenge/blob/main/src/feature/User/salvarUsuario.js"
    click MongooseConnect "https://github.com/sucodelarangela/backend-tech-challenge/blob/main/src/infra/mongoose/mongooseConect.js"
    click Modelos "https://github.com/sucodelarangela/backend-tech-challenge/blob/main/src/infra/mongoose/modelos.js"
    click AccountRepo "https://github.com/sucodelarangela/backend-tech-challenge/blob/main/src/infra/mongoose/repository/accountRepository.js"
    click DetailedAccountRepo "https://github.com/sucodelarangela/backend-tech-challenge/blob/main/src/infra/mongoose/repository/detailedAccountRepository.js"
    click CardRepo "https://github.com/sucodelarangela/backend-tech-challenge/blob/main/src/infra/mongoose/repository/cardRepository.js"
    click UserRepo "https://github.com/sucodelarangela/backend-tech-challenge/blob/main/src/infra/mongoose/repository/userRepository.js"

    %% Styles
    classDef external fill:#FFD580,stroke:#E59400,stroke-width:1px
    classDef presentation fill:#B3E5FC,stroke:#0288D1,stroke-width:1px
    classDef business fill:#C8E6C9,stroke:#388E3C,stroke-width:1px
    classDef data fill:#F0F4C3,stroke:#AFB42B,stroke-width:1px
    classDef db fill:#FFCCBC,stroke:#D84315,stroke-width:1px
    classDef docs fill:#E1BEE7,stroke:#8E24AA,stroke-width:1px
```
