# kitaminka/tic-tac-toe architecture

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

- Interactive diagram: https://gitdiagram.com/kitaminka/tic-tac-toe
- Repository: https://github.com/kitaminka/tic-tac-toe

## Overview

##### Project type and purpose
- This is a full-stack web application (Node.js/Express) implementing a Tic-Tac-Toe game with:
- Room system (multiple game instances)
- Discord-based OAuth2 authorization
- Real-time communication via websockets (Socket.io)
- MongoDB data storage
- It follows an MVC (Model-View-Controller) pattern, as noted in the README.

##### File structure
- Top-level files:
- app.js – entry point, configures Express, middleware, socket server
- package.json / .env.example – dependencies & configuration
- Directories:
- controllers/ – Express controller functions for users, rooms, games, main
- models/ – Mongoose schemas for User and Room
- modules/ – helper modules: socketModule (websocket logic), userModule (Discord OAuth/session)
- routes/ – Express routers mapping HTTP paths to controllers
- public/ – static assets: CSS, client-side JS for home and room pages, images
- views/ – EJS templates for auth, home, room

##### README for insights
- Stack: Node.js, Express, Socket.io, MongoDB, Discord OAuth
- Architecture: MVC, Socket usage for real-time moves, OAuth2 flow to Discord
- Features: authorization, multi-room gameplay, persistence of room/user data

##### Detailed elements
- Labels:
- “Browser (EJS + JS)”
- “Express Routes”
- “Controllers”
- “userModule (Discord OAuth)”
- “socketModule (Socket.io)”
- “Mongoose Models”
- “MongoDB”
- “Discord OAuth2 Service”
- HTTP → and ← between Browser and Express Routes

## Diagram (Mermaid)

```mermaid
flowchart TD
    subgraph "Client/UI"
        direction TB
        Browser["Browser\n(EJS Templates & JS)"]:::client
        auth_ejs["views/auth.ejs"]:::client
        home_ejs["views/home.ejs"]:::client
        room_ejs["views/room.ejs"]:::client
        home_js["home.js"]:::client
        room_js["room.js"]:::client
        auth_css["auth.css"]:::client
        home_css["home.css"]:::client
        room_css["room.css"]:::client
    end

    subgraph "Backend"
        direction TB
        app["app.js"]:::backend

        subgraph "Routes"
            MR["mainRouter"]:::backend
            UR["userRouter"]:::backend
            RoR["roomRouter"]:::backend
            GR["gameRouter"]:::backend
        end

        subgraph "Controllers"
            MC["mainController"]:::backend
            UC["userController"]:::backend
            RoC["roomController"]:::backend
            GC["gameController"]:::backend
        end

        subgraph "Modules"
            UM["userModule\n(Discord OAuth)"]:::backend
            SM["socketModule\n(Socket.io)"]:::backend
        end

        subgraph "Models"
            UMd["userModel"]:::backend
            RMd["roomModel"]:::backend
        end
    end

    subgraph "Database & External"
        direction TB
        DB["MongoDB"]:::db
        DIS["Discord OAuth2 Service"]:::external
    end

    Browser -->|"HTTP GET/POST"| MR
    Browser -->|"HTTP GET/POST"| UR
    Browser -->|"HTTP GET/POST"| RoR
    Browser -->|"HTTP GET/POST"| GR

    MR --> MC
    UR --> UC
    RoR --> RoC
    GR --> GC

    MC --> UMd
    UC --> UMd
    RoC --> RMd
    GC --> RMd

    UC --> UM
    UM -->|"OAuth2 flow"| DIS

    Browser -->|"WebSocket"| SM
    SM --> RMd
    SM --> Browser

    UMd --> DB
    RMd --> DB

    app --> MR
    app --> UR
    app --> RoR
    app --> GR
    app --> SM

    click app "https://github.com/kitaminka/tic-tac-toe/blob/main/app.js"
    click MR "https://github.com/kitaminka/tic-tac-toe/blob/main/routes/mainRouter.js"
    click UR "https://github.com/kitaminka/tic-tac-toe/blob/main/routes/userRouter.js"
    click RoR "https://github.com/kitaminka/tic-tac-toe/blob/main/routes/roomRouter.js"
    click GR "https://github.com/kitaminka/tic-tac-toe/blob/main/routes/gameRouter.js"
    click MC "https://github.com/kitaminka/tic-tac-toe/blob/main/controllers/mainController.js"
    click UC "https://github.com/kitaminka/tic-tac-toe/blob/main/controllers/userController.js"
    click RoC "https://github.com/kitaminka/tic-tac-toe/blob/main/controllers/roomController.js"
    click GC "https://github.com/kitaminka/tic-tac-toe/blob/main/controllers/gameController.js"
    click UM "https://github.com/kitaminka/tic-tac-toe/blob/main/modules/userModule.js"
    click SM "https://github.com/kitaminka/tic-tac-toe/blob/main/modules/socketModule.js"
    click UMd "https://github.com/kitaminka/tic-tac-toe/blob/main/models/userModel.js"
    click RMd "https://github.com/kitaminka/tic-tac-toe/blob/main/models/roomModel.js"
    click auth_ejs "https://github.com/kitaminka/tic-tac-toe/blob/main/views/auth.ejs"
    click home_ejs "https://github.com/kitaminka/tic-tac-toe/blob/main/views/home.ejs"
    click room_ejs "https://github.com/kitaminka/tic-tac-toe/blob/main/views/room.ejs"
    click home_js "https://github.com/kitaminka/tic-tac-toe/blob/main/public/js/home.js"
    click room_js "https://github.com/kitaminka/tic-tac-toe/blob/main/public/js/room.js"
    click auth_css "https://github.com/kitaminka/tic-tac-toe/blob/main/public/css/auth.css"
    click home_css "https://github.com/kitaminka/tic-tac-toe/blob/main/public/css/home.css"
    click room_css "https://github.com/kitaminka/tic-tac-toe/blob/main/public/css/room.css"

    classDef client fill:#D0E7FF,stroke:#036,stroke-width:1px
    classDef backend fill:#D0FFD6,stroke:#070,stroke-width:1px
    classDef db fill:#FFE0B2,stroke:#E65,stroke-width:1px
    classDef external fill:#E1BEE7,stroke:#940,stroke-width:1px
```
