# shmiklak/nomination architecture

> Architecture diagram of the GitHub repository shmiklak/nomination, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-05). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/shmiklak/nomination
- Repository: https://github.com/shmiklak/nomination

## Overview

NomiNation is a Laravel and React/Inertia platform for community beatmap-modding queues. Mappers browse queues, submit beatmaps, and track requests; nominators manage queues and members, review requests, and record responses. Queue and beatmap state lives in Eloquent models, while osu! data and community notifications integrate with external services. The README documents the broader product capabilities; some frontend pages and controllers are unsampled, so only evidenced relationships are shown.

Main entry points: [`app/Http/Controllers/BeatmapsController.php`](https://github.com/shmiklak/nomination/blob/main/app/Http/Controllers/BeatmapsController.php) (Beatmap requests), [`app/Http/Controllers/NominatorController.php`](https://github.com/shmiklak/nomination/blob/main/app/Http/Controllers/NominatorController.php) (Nominator responses), [`routes/web.php`](https://github.com/shmiklak/nomination/blob/main/routes/web.php) (Web routes), [`app/Models/Queue.php`](https://github.com/shmiklak/nomination/blob/main/app/Models/Queue.php) (Queue state)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_web["Web experience"]
  node_web_routes["Web routes<br/>[web.php]"]
  node_mapper_pages["Mapper pages"]
  node_queue_pages["Queue pages"]
end

subgraph group_queues["Queue operations"]
  node_queues_controller["Queue management"]
  node_queue_model["Queue state<br/>[Queue.php]"]
  node_database[("Application database<br/>[database.php]")]
end

subgraph group_review["Request review"]
  node_requests_controller["Beatmap requests"]
  node_nominator_controller["Nominator responses"]
  node_beatmap_model["Beatmap state<br/>[Beatmap.php]"]
  node_response_model["Nominator response"]
end

subgraph group_integrations["External integrations"]
  node_osu_api["osu! API client<br/>[OsuApi.php]"]
  node_discord["Discord notifications<br/>[Discord.php]"]
  node_irc_command["IRC notification command<br/>[SendIRCMessage.php]"]
  node_irc_service["IRC client<br/>[IRCService.php]"]
  node_discord_service["Discord service<br/>[Discord.php]"]
end

subgraph group_identity["Identity"]
  node_user_model["User accounts<br/>[User.php]"]
  node_osu_service["osu! OAuth provider<br/>[OsuProvider.php]"]
  node_oauth_controller["OAuth sign-in"]
end

node_mapper(("Mapper"))
node_nominator(("Nominator"))
node_osu_external(("osu! services"))
node_discord_external(("Discord"))
node_irc_external(("IRC network"))

node_mapper -->|"browses and submits"| node_web_routes
node_nominator -->|"manages and reviews"| node_web_routes
node_web_routes -->|"routes requests"| node_requests_controller
node_web_routes -->|"routes queues"| node_queues_controller
node_web_routes -->|"routes responses"| node_nominator_controller
node_requests_controller -->|"renders request views"| node_mapper_pages
node_queues_controller -->|"renders queue views"| node_queue_pages
node_requests_controller -->|"loads queue"| node_queue_model
node_requests_controller -->|"creates requests"| node_beatmap_model
node_requests_controller -->|"fetches beatmap data"| node_osu_api
node_requests_controller -->|"notifies new request"| node_discord_service
node_nominator_controller -->|"loads queue"| node_queue_model
node_nominator_controller -->|"updates request status"| node_beatmap_model
node_nominator_controller -->|"saves responses"| node_response_model
node_nominator_controller -->|"sends response alerts"| node_discord_service
node_nominator_controller -->|"dispatches accepted notice"| node_irc_command
node_queues_controller -->|"creates and updates"| node_queue_model
node_oauth_controller -->|"finds or creates account"| node_user_model
node_oauth_controller -->|"authenticates with"| node_osu_service
node_oauth_controller -->|"revokes token"| node_osu_api
node_osu_api -->|"requests osu! data"| node_osu_external
node_discord_service -->|"sends webhooks"| node_discord_external
node_irc_command -->|"sends message"| node_irc_service
node_irc_service -->|"writes IRC protocol"| node_irc_external
node_queue_model -.->|"persists queue data"| node_database
node_beatmap_model -.->|"persists beatmap data"| node_database
node_response_model -.->|"persists response data"| node_database
node_user_model -.->|"persists user data"| node_database

click node_web_routes "https://github.com/shmiklak/nomination/blob/main/routes/web.php"
click node_mapper_pages "https://github.com/shmiklak/nomination/tree/main/resources/js/pages"
click node_queue_pages "https://github.com/shmiklak/nomination/tree/main/resources/js/pages/queues"
click node_requests_controller "https://github.com/shmiklak/nomination/blob/main/app/Http/Controllers/BeatmapsController.php"
click node_queues_controller "https://github.com/shmiklak/nomination/blob/main/app/Http/Controllers/QueuesController.php"
click node_nominator_controller "https://github.com/shmiklak/nomination/blob/main/app/Http/Controllers/NominatorController.php"
click node_queue_model "https://github.com/shmiklak/nomination/blob/main/app/Models/Queue.php"
click node_beatmap_model "https://github.com/shmiklak/nomination/blob/main/app/Models/Beatmap.php"
click node_response_model "https://github.com/shmiklak/nomination/blob/main/app/Models/NominatorResponse.php"
click node_user_model "https://github.com/shmiklak/nomination/blob/main/app/Models/User.php"
click node_database "https://github.com/shmiklak/nomination/blob/main/config/database.php"
click node_osu_api "https://github.com/shmiklak/nomination/blob/main/app/Services/OsuApi.php"
click node_osu_service "https://github.com/shmiklak/nomination/blob/main/app/oAuth/OsuProvider.php"
click node_oauth_controller "https://github.com/shmiklak/nomination/blob/main/app/Http/Controllers/oAuth/OsuAuthController.php"
click node_discord "https://github.com/shmiklak/nomination/blob/main/app/Services/Discord.php"
click node_irc_command "https://github.com/shmiklak/nomination/blob/main/app/Console/Commands/SendIRCMessage.php"
click node_irc_service "https://github.com/shmiklak/nomination/blob/main/app/Services/IRCService.php"
click node_discord_service "https://github.com/shmiklak/nomination/blob/main/app/Services/Discord.php"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_web_routes,node_mapper_pages,node_queue_pages toneBlue
class node_queues_controller,node_queue_model,node_database toneAmber
class node_requests_controller,node_nominator_controller,node_beatmap_model,node_response_model toneMint
class node_osu_api,node_discord,node_irc_command,node_irc_service,node_discord_service toneRose
class node_user_model,node_osu_service,node_oauth_controller,node_mapper,node_nominator,node_osu_external,node_discord_external,node_irc_external toneIndigo
```

## Components

### Web experience

- [Web routes](https://github.com/shmiklak/nomination/blob/main/routes/web.php): `routes/web.php`
- [Mapper pages](https://github.com/shmiklak/nomination/tree/main/resources/js/pages): `resources/js/pages`
- [Queue pages](https://github.com/shmiklak/nomination/tree/main/resources/js/pages/queues): `resources/js/pages/queues`

### Queue operations

- [Queue management](https://github.com/shmiklak/nomination/blob/main/app/Http/Controllers/QueuesController.php): `app/Http/Controllers/QueuesController.php`
- [Queue state](https://github.com/shmiklak/nomination/blob/main/app/Models/Queue.php): `app/Models/Queue.php`
- [Application database](https://github.com/shmiklak/nomination/blob/main/config/database.php): `config/database.php`

### Request review

- [Beatmap requests](https://github.com/shmiklak/nomination/blob/main/app/Http/Controllers/BeatmapsController.php): `app/Http/Controllers/BeatmapsController.php`
- [Nominator responses](https://github.com/shmiklak/nomination/blob/main/app/Http/Controllers/NominatorController.php): `app/Http/Controllers/NominatorController.php`
- [Beatmap state](https://github.com/shmiklak/nomination/blob/main/app/Models/Beatmap.php): `app/Models/Beatmap.php`
- [Nominator response](https://github.com/shmiklak/nomination/blob/main/app/Models/NominatorResponse.php): `app/Models/NominatorResponse.php`

### External integrations

- [osu! API client](https://github.com/shmiklak/nomination/blob/main/app/Services/OsuApi.php): `app/Services/OsuApi.php`
- [Discord notifications](https://github.com/shmiklak/nomination/blob/main/app/Services/Discord.php): `app/Services/Discord.php`
- [IRC notification command](https://github.com/shmiklak/nomination/blob/main/app/Console/Commands/SendIRCMessage.php): `app/Console/Commands/SendIRCMessage.php`
- [IRC client](https://github.com/shmiklak/nomination/blob/main/app/Services/IRCService.php): `app/Services/IRCService.php`
- [Discord service](https://github.com/shmiklak/nomination/blob/main/app/Services/Discord.php): `app/Services/Discord.php`

### Identity

- [User accounts](https://github.com/shmiklak/nomination/blob/main/app/Models/User.php): `app/Models/User.php`
- [osu! OAuth provider](https://github.com/shmiklak/nomination/blob/main/app/oAuth/OsuProvider.php): `app/oAuth/OsuProvider.php`
- [OAuth sign-in](https://github.com/shmiklak/nomination/blob/main/app/Http/Controllers/oAuth/OsuAuthController.php): `app/Http/Controllers/oAuth/OsuAuthController.php`

### Other components

- **Mapper**
- **Nominator**
- **osu! services**
- **Discord**
- **IRC network**

## Connections

- Mapper → Web routes: browses and submits
- Nominator → Web routes: manages and reviews
- Web routes → Beatmap requests: routes requests (evidence: `routes/web.php`)
- Web routes → Queue management: routes queues (evidence: `routes/web.php`)
- Web routes → Nominator responses: routes responses (evidence: `routes/web.php`)
- Beatmap requests → Mapper pages: renders request views (evidence: `app/Http/Controllers/BeatmapsController.php`)
- Queue management → Queue pages: renders queue views (evidence: `app/Http/Controllers/QueuesController.php`)
- Beatmap requests → Queue state: loads queue (evidence: `app/Http/Controllers/BeatmapsController.php`)
- Beatmap requests → Beatmap state: creates requests (evidence: `app/Http/Controllers/BeatmapsController.php`)
- Beatmap requests → osu! API client: fetches beatmap data (evidence: `app/Http/Controllers/BeatmapsController.php`)
- Beatmap requests → Discord service: notifies new request (evidence: `app/Http/Controllers/BeatmapsController.php`)
- Nominator responses → Queue state: loads queue (evidence: `app/Http/Controllers/NominatorController.php`)
- Nominator responses → Beatmap state: updates request status (evidence: `app/Http/Controllers/NominatorController.php`)
- Nominator responses → Nominator response: saves responses (evidence: `app/Http/Controllers/NominatorController.php`)
- Nominator responses → Discord service: sends response alerts (evidence: `app/Http/Controllers/NominatorController.php`)
- Nominator responses → IRC notification command: dispatches accepted notice (evidence: `app/Http/Controllers/NominatorController.php`)
- Queue management → Queue state: creates and updates (evidence: `app/Http/Controllers/QueuesController.php`)
- OAuth sign-in → User accounts: finds or creates account (evidence: `app/Http/Controllers/oAuth/OsuAuthController.php`)
- OAuth sign-in → osu! OAuth provider: authenticates with
- OAuth sign-in → osu! API client: revokes token (evidence: `app/Http/Controllers/oAuth/OsuAuthController.php`)
- osu! API client → osu! services: requests osu! data
- Discord service → Discord: sends webhooks (evidence: `app/Services/Discord.php`)
- IRC notification command → IRC client: sends message (evidence: `app/Console/Commands/SendIRCMessage.php`)
- IRC client → IRC network: writes IRC protocol (evidence: `app/Services/IRCService.php`)
- Queue state → Application database: persists queue data
- Beatmap state → Application database: persists beatmap data
- Nominator response → Application database: persists response data
- User accounts → Application database: persists user data
