# ingsoft1-capybaras/switcher-backend architecture

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

- Interactive diagram: https://gitdiagram.com/ingsoft1-capybaras/switcher-backend
- Repository: https://github.com/ingsoft1-capybaras/switcher-backend

## Overview

##### Project Type and Purpose
- This is a modular, monolithic backend API built with FastAPI (served by Uvicorn).
- It serves a board‑game application, exposing endpoints for entities such as Board, Game, Player, FigureCards, MovementCards, GameState, PartialMovement.
- Persists data in (presumably) a relational database via a shared database module.

##### File Structure
- Top‐level:
- main.py – FastAPI app entry point
- connection_manager.py & database/db.py – sets up DB connection pooling
- settings.py – environment/config management
- run_server.sh & Makefile – deployment/test scripts
- Feature modules (each under its own directory):
- {board, game, player, figureCards, movementCards, gameState, partial_movement}
– endpoints.py (HTTP layer)
– <feature>_logic.py (business logic/domain)
– <feature>_repository.py (data access)
– models.py (ORM/data models)
– schemas.py (Pydantic request/response)
- tests/ – unit & integration tests

##### README for Additional Insights
- Server is launched via `uvicorn main:app --reload`, reads ENVIRONMENT variable to select DB.
- Uses Python 3.6+, FastAPI, Pydantic, a SQL‐backed database.
- No frontend here – purely backend API.

##### Main Components
A. External Client (could be CLI, frontend, other services)
B. API Gateway Layer
- FastAPI (main.py)
- Route registration via each module’s endpoints.py
C. Domain Layer (per‑feature business logic components)
- BoardLogic, GameLogic, PlayerLogic, etc.
D. Data Access Layer
- BoardRepository, GameRepository, etc.
- ConnectionManager & pooled DB sessions (database/db.py)
E. Database
- PostgreSQL/MySQL (or SQLite depending on ENV)
F. Configuration
- settings.py driving ENVIRONMENT → DB selection
G. Dev/Test Harness (Makefile, run_server.sh, pytest)

##### Architectural Patterns & Principles
- Layered (Presentation → Domain → Persistence)
- Modular feature boundaries (each feature grouped in its directory)
- Dependency Inversion: Logic depends on abstracted repository interfaces
- Single responsibility per module
- Environment‐driven configuration for multiple databases

##### Technologies & Frameworks to Label
- FastAPI + Uvicorn
- Pydantic for Schemas
- SQLAlchemy or equivalent ORM (in models.py)
- Connection Pool Manager (connection_manager.py)
- pytest for testing
- bash scripts & Makefile for orchestration

##### Essential Elements
- Labels: Module names, file names (e.g., board/endpoints.py)
- Configuration overlay: settings.py feeding into DB connection

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% External Client and Config
    ExternalClient["External Client"]:::external
    Settings["Configuration (settings.py)"]:::config

    %% API Server with layers
    subgraph "API Server"
        direction TB
        FastAPI["FastAPI App (main.py)"]:::api

        subgraph "Endpoints Layer"
            direction TB
            BoardEP["Board Endpoints"]:::api
            GameEP["Game Endpoints"]:::api
            PlayerEP["Player Endpoints"]:::api
            FigureEP["FigureCards Endpoints"]:::api
            MovementEP["MovementCards Endpoints"]:::api
            GameStateEP["GameState Endpoints"]:::api
        end

        subgraph "Business Logic Layer"
            direction TB
            BoardLogic["BoardLogic"]:::logic
            GameLogic["GameLogic"]:::logic
            PlayerLogic["PlayerLogic"]:::logic
            FigureLogic["FigureCardsLogic"]:::logic
            MovementLogic["MovementCardsLogic"]:::logic
            PartialLogic["PartialMovementLogic"]:::logic
        end

        subgraph "Data Access Layer"
            direction TB
            BoardRepo["BoardRepository"]:::data
            GameRepo["GameRepository"]:::data
            PlayerRepo["PlayerRepository"]:::data
            FigureRepo["FigureCardsRepository"]:::data
            MovementRepo["MovementCardsRepository"]:::data
            GameStateRepo["GameStateRepository"]:::data
            PartialRepo["PartialMovementRepository"]:::data
            ConnectionM["Connection Manager"]:::data
            DBModule["DB Module"]:::data
        end
    end

    %% Database
    Database["Database"]:::db

    %% Dev & Testing Harness
    subgraph "Dev & Testing Harness"
        direction TB
        Makefile["Makefile"]:::tool
        RunScript["run_server.sh"]:::tool
        PytestIni["pytest.ini"]:::tool
        TestsDir["tests/"]:::tool
    end

    %% Connections
    ExternalClient -->|"HTTP Request"| FastAPI
    Settings -->|"config"| FastAPI
    Settings -->|"config"| DBModule

    FastAPI -->|"route registration"| BoardEP
    FastAPI -->|"route registration"| GameEP
    FastAPI -->|"route registration"| PlayerEP
    FastAPI -->|"route registration"| FigureEP
    FastAPI -->|"route registration"| MovementEP
    FastAPI -->|"route registration"| GameStateEP

    BoardEP -->|"call"| BoardLogic
    GameEP -->|"call"| GameLogic
    PlayerEP -->|"call"| PlayerLogic
    FigureEP -->|"call"| FigureLogic
    MovementEP -->|"call"| MovementLogic
    GameStateEP -->|"call"| GameStateRepo

    BoardLogic -->|"CRUD ops"| BoardRepo
    GameLogic -->|"CRUD ops"| GameRepo
    PlayerLogic -->|"CRUD ops"| PlayerRepo
    FigureLogic -->|"CRUD ops"| FigureRepo
    MovementLogic -->|"CRUD ops"| MovementRepo
    PartialLogic -->|"CRUD ops"| PartialRepo

    BoardRepo -->|"SQL Query"| ConnectionM
    GameRepo -->|"SQL Query"| ConnectionM
    PlayerRepo -->|"SQL Query"| ConnectionM
    FigureRepo -->|"SQL Query"| ConnectionM
    MovementRepo -->|"SQL Query"| ConnectionM
    GameStateRepo -->|"SQL Query"| ConnectionM
    PartialRepo -->|"SQL Query"| ConnectionM

    ConnectionM -->|"session factory"| DBModule
    DBModule -->|"execute SQL"| Database
    Database -->|"result set"| DBModule

    Makefile -->|"runs"| RunScript
    Makefile -->|"invokes"| PytestIni
    PytestIni -->|"configures"| TestsDir

    %% Click Events
    click FastAPI "https://github.com/ingsoft1-capybaras/switcher-backend/blob/main/main.py"
    click Settings "https://github.com/ingsoft1-capybaras/switcher-backend/blob/main/settings.py"
    click ConnectionM "https://github.com/ingsoft1-capybaras/switcher-backend/blob/main/connection_manager.py"
    click DBModule "https://github.com/ingsoft1-capybaras/switcher-backend/blob/main/database/db.py"

    click BoardEP "https://github.com/ingsoft1-capybaras/switcher-backend/blob/main/board/endpoints.py"
    click BoardLogic "https://github.com/ingsoft1-capybaras/switcher-backend/blob/main/board/board_logic.py"
    click BoardRepo "https://github.com/ingsoft1-capybaras/switcher-backend/blob/main/board/board_repository.py"
    click BoardModels "https://github.com/ingsoft1-capybaras/switcher-backend/blob/main/board/models.py"
    click BoardSchemas "https://github.com/ingsoft1-capybaras/switcher-backend/blob/main/board/schemas.py"

    click GameEP "https://github.com/ingsoft1-capybaras/switcher-backend/blob/main/game/endpoints.py"
    click GameLogic "https://github.com/ingsoft1-capybaras/switcher-backend/blob/main/game/game_logic.py"
    click GameRepo "https://github.com/ingsoft1-capybaras/switcher-backend/blob/main/game/game_repository.py"
    click GameModels "https://github.com/ingsoft1-capybaras/switcher-backend/blob/main/game/models.py"
    click GameSchemas "https://github.com/ingsoft1-capybaras/switcher-backend/blob/main/game/schemas.py"

    click PlayerEP "https://github.com/ingsoft1-capybaras/switcher-backend/blob/main/player/endpoints.py"
    click PlayerLogic "https://github.com/ingsoft1-capybaras/switcher-backend/blob/main/player/player_logic.py"
    click PlayerRepo "https://github.com/ingsoft1-capybaras/switcher-backend/blob/main/player/player_repository.py"
    click PlayerModels "https://github.com/ingsoft1-capybaras/switcher-backend/blob/main/player/models.py"
    click PlayerSchemas "https://github.com/ingsoft1-capybaras/switcher-backend/blob/main/player/schemas.py"

    click FigureEP "https://github.com/ingsoft1-capybaras/switcher-backend/blob/main/figureCards/endpoints.py"
    click FigureLogic "https://github.com/ingsoft1-capybaras/switcher-backend/blob/main/figureCards/figure_cards_logic.py"
    click FigureRepo "https://github.com/ingsoft1-capybaras/switcher-backend/blob/main/figureCards/figure_cards_repository.py"
    click FigureModels "https://github.com/ingsoft1-capybaras/switcher-backend/blob/main/figureCards/models.py"
    click FigureSchemas "https://github.com/ingsoft1-capybaras/switcher-backend/blob/main/figureCards/schemas.py"

    click MovementEP "https://github.com/ingsoft1-capybaras/switcher-backend/blob/main/movementCards/endpoints.py"
    click MovementLogic "https://github.com/ingsoft1-capybaras/switcher-backend/blob/main/movementCards/movement_cards_logic.py"
    click MovementRepo "https://github.com/ingsoft1-capybaras/switcher-backend/blob/main/movementCards/movement_cards_repository.py"
    click MovementModels "https://github.com/ingsoft1-capybaras/switcher-backend/blob/main/movementCards/models.py"
    click MovementSchemas "https://github.com/ingsoft1-capybaras/switcher-backend/blob/main/movementCards/schemas.py"

    click MovementUtils "https://github.com/ingsoft1-capybaras/switcher-backend/blob/main/movementCards/utils.py"

    click GameStateEP "https://github.com/ingsoft1-capybaras/switcher-backend/blob/main/gameState/endpoints.py"
    click GameStateRepo "https://github.com/ingsoft1-capybaras/switcher-backend/blob/main/gameState/game_state_repository.py"
    click GameStateModels "https://github.com/ingsoft1-capybaras/switcher-backend/blob/main/gameState/models.py"
    click GameStateSchemas "https://github.com/ingsoft1-capybaras/switcher-backend/blob/main/gameState/schemas.py"

    click PartialLogic "https://github.com/ingsoft1-capybaras/switcher-backend/blob/main/partial_movement/partial_movement_logic.py"
    click PartialRepo "https://github.com/ingsoft1-capybaras/switcher-backend/blob/main/partial_movement/partial_movement_repository.py"
    click PartialModels "https://github.com/ingsoft1-capybaras/switcher-backend/blob/main/partial_movement/models.py"
    click PartialSchemas "https://github.com/ingsoft1-capybaras/switcher-backend/blob/main/partial_movement/schemas.py"

    click Makefile "https://github.com/ingsoft1-capybaras/switcher-backend/tree/main/Makefile"
    click RunScript "https://github.com/ingsoft1-capybaras/switcher-backend/blob/main/run_server.sh"
    click PytestIni "https://github.com/ingsoft1-capybaras/switcher-backend/blob/main/pytest.ini"
    click TestsDir "https://github.com/ingsoft1-capybaras/switcher-backend/tree/main/tests/"

    %% Styles
    classDef external fill:#b3e5fc,stroke:#0288d1,color:#000
    classDef config fill:#e0e0e0,stroke:#9e9e9e,color:#000
    classDef api fill:#c8e6c9,stroke:#388e3c,color:#000
    classDef logic fill:#ffe0b2,stroke:#f57c00,color:#000
    classDef data fill:#e1bee7,stroke:#8e24aa,color:#000
    classDef db fill:#eeeeee,stroke:#616161,color:#000
    classDef tool fill:#fff9c4,stroke:#fbc02d,color:#000
```
