# danielagmz/pyramids architecture

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

- Interactive diagram: https://gitdiagram.com/danielagmz/pyramids
- Repository: https://github.com/danielagmz/pyramids

## Overview

##### Project type and purpose
- This is a full-stack JavaScript web application that provides a real-time, map-based game interface (with roles for admin, lobby, player, etc.).
- The backend is a Node.js server offering both HTTP endpoints (AuthController, Admin.js, Game.js, etc.) and a WebSocket channel for live game events.
- The frontend is a static client (HTML/CSS/vanilla JS) served via a “live server” extension on port 5500.

##### File structure
- Top-level:
- client/ – all static assets (html, css, js, images, map elements)
- server/ – Node.js code (server.js, router.js, controllers, WebSocketHandler)
- configs.js – global configuration (ports, URLs, feature flags)
- package.json & package-lock.json – dependencies and scripts
- server/controllers/ follows an MVC-style pattern: each controller encapsulates a domain (Auth, Player, Game, Pyramid, Mapa, Admin).
- server/router.js assembles HTTP routes; WebSocketHandler.js sets up bi-directional socket messaging.
- README describes a dual-server setup: the static client via Chrome live server and the Node backend on localhost:8080.

##### README for architecture insights
- Two distinct “servers”:
1. Live-reload static server (frontend) at http://localhost:5500
2. Node.js application server (backend) at http://localhost:8080
- No explicit database folder, so persistence may be in-memory or handled inside controllers (if a DB is integrated, it would appear in configs.js).

##### Elements
- Clear labels: e.g., “Browser Client,” “Live Server (5500),” “Node.js API (8080),” “AuthController,” “WebSocketHandler.”
– HTTP request/response flows (login, admin calls).
– WebSocket messages (subscribe, broadcast game state).
– Controller ↔ persistence interactions.
– Rectangles for servers/components
– Clouds for external services (e.g., map APIs)

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Frontend Layer
    subgraph "Frontend"
        direction TB
        Browser["Browser Client UI"]:::frontend
        StaticServer["Static File Server (Live-Reload :5500)"]:::frontend
        subgraph "Static Assets"
            direction TB
            HTML["HTML Templates"]:::frontend
            CSS["CSS Styles"]:::frontend
            JS["JavaScript Controllers"]:::frontend
        end
    end

    %% Backend Layer
    subgraph "Backend"
        direction TB
        NodeServer["Node.js Application Server (8080)"]:::backend
        subgraph "Transport Layer"
            direction TB
            HTTPRouter["HTTP Router"]:::backend
            WSHandler["WebSocket Handler"]:::backend
        end
        subgraph "Controllers / Business Logic"
            direction TB
            Auth["AuthController"]:::backend
            Admin["AdminController"]:::backend
            Game["GameController"]:::backend
            Player["PlayerController"]:::backend
            Mapa["MapaController"]:::backend
            Pyramid["PyramidController"]:::backend
        end
        Persistence["Persistence Layer"]:::persistence
        Configs["Global Configuration"]:::config
        NPM["NPM Scripts & Config"]:::config
    end

    %% Interactions
    Browser -->|"GET assets"| StaticServer
    StaticServer -->|"Serves HTML/CSS/JS"| Browser

    Browser -->|"HTTP API requests"| HTTPRouter
    Browser -->|"WebSocket connect"| WSHandler

    HTTPRouter -->|"routes to"| Auth
    HTTPRouter -->|"routes to"| Admin
    HTTPRouter -->|"routes to"| Game
    HTTPRouter -->|"routes to"| Player
    HTTPRouter -->|"routes to"| Mapa
    HTTPRouter -->|"routes to"| Pyramid

    WSHandler -->|"handles events for"| Auth
    WSHandler -->|"handles events for"| Admin
    WSHandler -->|"handles events for"| Game
    WSHandler -->|"handles events for"| Player
    WSHandler -->|"handles events for"| Mapa
    WSHandler -->|"handles events for"| Pyramid

    Auth -->|"reads/writes"| Persistence
    Admin -->|"reads/writes"| Persistence
    Game -->|"reads/writes"| Persistence
    Player -->|"reads/writes"| Persistence
    Mapa -->|"reads/writes"| Persistence
    Pyramid -->|"reads/writes"| Persistence

    NodeServer --> HTTPRouter
    NodeServer --> WSHandler
    NodeServer --> Configs
    NodeServer --> NPM

    %% Click Events
    click Browser "https://github.com/danielagmz/pyramids/tree/main/client/"
    click HTML "https://github.com/danielagmz/pyramids/tree/main/client/html/"
    click CSS "https://github.com/danielagmz/pyramids/tree/main/client/css/"
    click JS "https://github.com/danielagmz/pyramids/tree/main/client/js/"
    click StaticServer "https://github.com/danielagmz/pyramids/tree/main/client/"
    click NodeServer "https://github.com/danielagmz/pyramids/blob/main/server/server.js"
    click HTTPRouter "https://github.com/danielagmz/pyramids/blob/main/server/router.js"
    click WSHandler "https://github.com/danielagmz/pyramids/blob/main/server/controllers/WebSocketHandler.js"
    click Auth "https://github.com/danielagmz/pyramids/blob/main/server/controllers/AuthController.js"
    click Admin "https://github.com/danielagmz/pyramids/blob/main/server/controllers/Admin.js"
    click Game "https://github.com/danielagmz/pyramids/blob/main/server/controllers/Game.js"
    click Player "https://github.com/danielagmz/pyramids/blob/main/server/controllers/Player.js"
    click Mapa "https://github.com/danielagmz/pyramids/blob/main/server/controllers/Mapa.js"
    click Pyramid "https://github.com/danielagmz/pyramids/blob/main/server/controllers/Pyramid.js"
    click Configs "https://github.com/danielagmz/pyramids/blob/main/configs.js"
    click NPM "https://github.com/danielagmz/pyramids/blob/main/package.json"

    %% Styles
    classDef frontend fill:#CCE5FF,stroke:#003366,color:#003366;
    classDef backend fill:#CCFFCC,stroke:#006600,color:#006600;
    classDef persistence fill:#FFF2CC,stroke:#997300,color:#997300;
    classDef external fill:#EEEEEE,stroke:#666666,color:#333333;
    classDef config fill:#CCFFFF,stroke:#006666,color:#006666;
```
