# pseudo-lab/event-bingo architecture

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

- Interactive diagram: https://gitdiagram.com/pseudo-lab/event-bingo
- Repository: https://github.com/pseudo-lab/event-bingo

## Overview

##### Project type and purpose
- This is a full-stack web application for running a Bingo game and a community board.
- The “backend” folder contains a Python FastAPI app (routes, services, Pydantic schemas, SQLAlchemy models, Alembic migrations), handling authentication (JWT + social login), bingo logic, and board/comment CRUD.
- The “frontend” folder contains a Vite + React + TypeScript app, organized into feature modules (Bingo, Builder, Community, Runner, Admin), offering UIs for playing Bingo, viewing/editing boards, and user flows.
- Dockerfiles and docker-compose.yaml orchestrate the backend, frontend, and a MySQL database.

##### File structure
- Top level:
- docker-compose.yaml → orchestrates 3 containers: frontend, backend, MySQL DB
- backend/ → Python app, Dockerfile, pyproject.toml, MySQL startup script
- frontend/ → React app, Dockerfile, package.json, Vite config
- backend/app/api/… → domain-specific route modules (auth, bingo, board), each with routes.py, schema.py, services/*.
- backend/app/models/… → ORM models.
- backend/app/core/… → DB setup, dependency injection, logging.
- backend/app/migrations/… → Alembic environment and version scripts.
- frontend/src/modules/… → feature folders, each with components and screens.
- frontend/src/api/*.ts → client wrappers for backend endpoints.

##### README for additional insights
- No content provided; architecture must be inferred from structure and naming conventions.

##### Elements
- Between Browser and React UI (user actions & rendering)
- Between React UI and API endpoints (/api/auth, /api/bingo, /api/board)
- Between Backend and DB (ORM queries)
- Between Backend and OAuth provider
- Blue rectangles for client-side components
- Green rectangles for server-side components
- Grey hexagon for external services (Discord)
- Annotations for key data flows: login→JWT, fetch boards, post comments, play bingo.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Client Layer
    Browser["Browser"]:::client
    Browser -->|"interacts with"| Frontend

    %% Docker Compose Network
    subgraph "Docker Compose Network"
        direction TB

        subgraph "Frontend Container"
            direction TB
            Frontend["React Frontend\n(Vite, React, TS)"]:::frontend
        end

        subgraph "Backend Container"
            direction TB
            BackendAPI["FastAPI Backend\n(Auth, Bingo, Board)"]:::backend
            Migrations["Alembic Migrations"]:::backend
            Tests["Pytest Test Suite"]:::backend
        end

        subgraph "Database Container"
            MySQL["MySQL Database"]:::database
        end
    end

    %% External Services
    Discord["Discord OAuth"]:::external
    Discord -->|"OAuth2 Code Exchange"| BackendAPI

    %% Data Flows
    Frontend -->|"/api/auth, /api/bingo, /api/board"| BackendAPI
    BackendAPI -->|"ORM Queries"| MySQL
    BackendAPI -->|"Run Migrations"| Migrations
    BackendAPI -->|"CI Tests"| Tests

    %% Click Events
    click docker_compose "https://github.com/pseudo-lab/event-bingo/blob/main/docker-compose.yaml"
    click frontend_docker "https://github.com/pseudo-lab/event-bingo/tree/main/frontend/Dockerfile"
    click backend_docker "https://github.com/pseudo-lab/event-bingo/tree/main/backend/Dockerfile"
    click main "https://github.com/pseudo-lab/event-bingo/blob/main/backend/app/main.py"
    click startup "https://github.com/pseudo-lab/event-bingo/blob/main/backend/app/start.py"
    click env "https://github.com/pseudo-lab/event-bingo/blob/main/backend/app/config/.env.example"
    click db_setup "https://github.com/pseudo-lab/event-bingo/blob/main/backend/app/core/db.py"
    click deps "https://github.com/pseudo-lab/event-bingo/blob/main/backend/app/core/dependencies.py"
    click log_conf "https://github.com/pseudo-lab/event-bingo/blob/main/backend/app/core/log.py"
    click base_schema "https://github.com/pseudo-lab/event-bingo/blob/main/backend/app/core/base_schema.py"
    click auth_routes "https://github.com/pseudo-lab/event-bingo/blob/main/backend/app/api/auth/routes.py"
    click auth_schema "https://github.com/pseudo-lab/event-bingo/blob/main/backend/app/api/auth/schema.py"
    click jwts "https://github.com/pseudo-lab/event-bingo/blob/main/backend/app/api/auth/services/jwts.py"
    click social_login "https://github.com/pseudo-lab/event-bingo/blob/main/backend/app/api/auth/services/social_login.py"
    click bingo_login "https://github.com/pseudo-lab/event-bingo/blob/main/backend/app/api/auth/services/bingo_login.py"
    click bb_routes "https://github.com/pseudo-lab/event-bingo/blob/main/backend/app/api/bingo/bingo_boards/routes.py"
    click bb_schema "https://github.com/pseudo-lab/event-bingo/blob/main/backend/app/api/bingo/bingo_boards/schema.py"
    click bb_services "https://github.com/pseudo-lab/event-bingo/blob/main/backend/app/api/bingo/bingo_boards/services.py"
    click bi_routes "https://github.com/pseudo-lab/event-bingo/blob/main/backend/app/api/bingo/bingo_interaction/routes.py"
    click bi_schema "https://github.com/pseudo-lab/event-bingo/blob/main/backend/app/api/bingo/bingo_interaction/schema.py"
    click bi_services "https://github.com/pseudo-lab/event-bingo/blob/main/backend/app/api/bingo/bingo_interaction/services.py"
    click mw_routes "https://github.com/pseudo-lab/event-bingo/blob/main/backend/app/api/bingo/meta_word/routes.py"
    click mw_schema "https://github.com/pseudo-lab/event-bingo/blob/main/backend/app/api/bingo/meta_word/schema.py"
    click mw_services "https://github.com/pseudo-lab/event-bingo/blob/main/backend/app/api/bingo/meta_word/services.py"
    click comment_routes "https://github.com/pseudo-lab/event-bingo/blob/main/backend/app/api/board/comment/routes.py"
    click comment_schema "https://github.com/pseudo-lab/event-bingo/blob/main/backend/app/api/board/comment/schema.py"
    click comment_services "https://github.com/pseudo-lab/event-bingo/blob/main/backend/app/api/board/comment/services.py"
    click crud_routes "https://github.com/pseudo-lab/event-bingo/blob/main/backend/app/api/board/crud/routes.py"
    click crud_schema "https://github.com/pseudo-lab/event-bingo/blob/main/backend/app/api/board/crud/schema.py"
    click crud_services "https://github.com/pseudo-lab/event-bingo/blob/main/backend/app/api/board/crud/services.py"
    click user_model "https://github.com/pseudo-lab/event-bingo/blob/main/backend/app/models/user.py"
    click bb_model "https://github.com/pseudo-lab/event-bingo/blob/main/backend/app/models/bingo/bingo_boards.py"
    click bi_model "https://github.com/pseudo-lab/event-bingo/blob/main/backend/app/models/bingo/bingo_interaction.py"
    click mw_model "https://github.com/pseudo-lab/event-bingo/blob/main/backend/app/models/bingo/meta_word.py"
    click bingo_schema_model "https://github.com/pseudo-lab/event-bingo/blob/main/backend/app/models/bingo/schema.py"
    click board_model "https://github.com/pseudo-lab/event-bingo/blob/main/backend/app/models/board/boards.py"
    click comments_model "https://github.com/pseudo-lab/event-bingo/blob/main/backend/app/models/board/comments.py"
    click board_schema_model "https://github.com/pseudo-lab/event-bingo/blob/main/backend/app/models/board/schema.py"
    click alembic_ini "https://github.com/pseudo-lab/event-bingo/blob/main/backend/app/alembic.ini"
    click migrations_env "https://github.com/pseudo-lab/event-bingo/blob/main/backend/app/migrations/env.py"
    click migrations_versions "https://github.com/pseudo-lab/event-bingo/tree/main/backend/app/migrations/versions/"
    click tests_conf "https://github.com/pseudo-lab/event-bingo/blob/main/backend/app/tests/conftest.py"
    click main_tsx "https://github.com/pseudo-lab/event-bingo/blob/main/frontend/src/main.tsx"
    click app_tsx "https://github.com/pseudo-lab/event-bingo/blob/main/frontend/src/App.tsx"
    click bingo_api "https://github.com/pseudo-lab/event-bingo/blob/main/frontend/src/api/bingo_api.ts"
    click board_api "https://github.com/pseudo-lab/event-bingo/blob/main/frontend/src/api/board_api.ts"
    click discord_btn "https://github.com/pseudo-lab/event-bingo/blob/main/frontend/src/components/common/DiscordLoginButton.tsx"
    click discord_icon "https://github.com/pseudo-lab/event-bingo/blob/main/frontend/src/components/common/DiscordIcon.tsx"
    click external_link "https://github.com/pseudo-lab/event-bingo/blob/main/frontend/src/components/common/ExternalLink.tsx"
    click logo "https://github.com/pseudo-lab/event-bingo/blob/main/frontend/src/components/common/PseudoLabLogo.tsx"
    click modules_bingo "https://github.com/pseudo-lab/event-bingo/tree/main/frontend/src/modules/Bingo/"
    click modules_builder "https://github.com/pseudo-lab/event-bingo/tree/main/frontend/src/modules/Builder/"
    click modules_community "https://github.com/pseudo-lab/event-bingo/tree/main/frontend/src/modules/Community/"
    click modules_runner "https://github.com/pseudo-lab/event-bingo/tree/main/frontend/src/modules/Runner/"
    click edit_apply "https://github.com/pseudo-lab/event-bingo/blob/main/frontend/src/modules/Admin/EditApplyForm.tsx"
    click header "https://github.com/pseudo-lab/event-bingo/tree/main/frontend/src/modules/Header/"
    click footer "https://github.com/pseudo-lab/event-bingo/blob/main/frontend/src/modules/Footer/Footer.tsx"
    click global_styles "https://github.com/pseudo-lab/event-bingo/blob/main/frontend/src/styles/GlobalStyles.ts"
    click date_utils "https://github.com/pseudo-lab/event-bingo/blob/main/frontend/src/utils/DateUtils.ts"
    click storage_utils "https://github.com/pseudo-lab/event-bingo/blob/main/frontend/src/utils/LocalStorageUtils.ts"
    click vite_config "https://github.com/pseudo-lab/event-bingo/blob/main/frontend/vite.config.ts"

    %% Styles
    classDef client fill:#B3E5FC,stroke:#0288D1,color:#000
    classDef frontend fill:#BBDEFB,stroke:#1976D2,color:#000
    classDef backend fill:#C8E6C9,stroke:#388E3C,color:#000
    classDef database fill:#FFE0B2,stroke:#F57C00,color:#000
    classDef external fill:#ECEFF1,stroke:#607D8B,color:#000
```
