# ivaqis/arknights-tracker architecture

> Architecture diagram of the GitHub repository ivaqis/arknights-tracker, 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/ivaqis/arknights-tracker
- Repository: https://github.com/ivaqis/arknights-tracker

## Overview

Goyfield.moe is an Arknights: Endfield pull tracker and game-data reference. The main user workflow is to track or import pulls, then view pull-derived statistics; the README documents browser-local pull retention and frontend requests to the backend during imports. The frontend also models game data, crafting/buildings, and events. The backend provides API and persistence capabilities, but the sampled sources expose only application setup and a generic controller, so most endpoint-level connections are omitted rather than inferred.

Main entry points: [`arknights-tracker/src/lib/api`](https://github.com/ivaqis/arknights-tracker/tree/main/arknights-tracker/src/lib/api) (API clients), [`arknights-tracker/src/lib/classes/gameData`](https://github.com/ivaqis/arknights-tracker/tree/main/arknights-tracker/src/lib/classes/gameData) (Game data models), [`arknights-tracker/src/lib/classes/pulls/PullParser.ts`](https://github.com/ivaqis/arknights-tracker/blob/main/arknights-tracker/src/lib/classes/pulls/PullParser.ts) (Pull processing), [`goyfield-backend/src/api/controllers/Controller.ts`](https://github.com/ivaqis/arknights-tracker/blob/main/goyfield-backend/src/api/controllers/Controller.ts) (API controllers)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_pulls["Pull tracking"]
  node_pull_runtime["Pull processing<br/>[PullParser.ts]"]
  node_pull_stats["Pull statistics"]
  node_pull_storage["Pull merging<br/>[PullMerger.ts]"]
end

subgraph group_api["API services"]
  node_frontend_api["API clients"]
  node_import_api["Pull import"]
  node_sync_api["Pull sync"]
  node_global_stats["Global banner stats"]
  node_profile_api["Profile lookup"]
end

subgraph group_game["Game data"]
  node_game_data["Game data models"]
  node_item_storage["Item catalog<br/>[ItemStorage.ts]"]
  node_miner_storage["Mining buildings<br/>[MinerStorage.ts]"]
  node_vaporizer_storage["Vaporizer buildings"]
  node_crafting["Crafting recipes"]
  node_game_events["Game events"]
end

subgraph group_backend["Backend services"]
  node_backend_app["HTTP application<br/>[App.ts]"]
  node_backend_api["API controllers<br/>[Controller.ts]"]
  node_backend_db[("Postgres data")]
  node_nsfw["Image moderation"]
end

subgraph group_platform["External services"]
  node_browser_store[("Browser local storage")]
  node_postgres[("PostgreSQL")]
  node_sightengine["Sightengine"]
end

node_user(("Tracker user"))

node_user -.->|"tracks pulls"| node_pull_runtime
node_pull_runtime -.->|"calculates stats"| node_pull_stats
node_pull_runtime -.->|"merges pulls"| node_pull_storage
node_user -.->|"imports pulls"| node_frontend_api
node_frontend_api -.->|"uses import endpoints"| node_import_api
node_frontend_api -.->|"uses sync endpoints"| node_sync_api
node_frontend_api -.->|"requests statistics"| node_global_stats
node_frontend_api -.->|"looks up profile"| node_profile_api
node_user -.->|"retains pulls"| node_browser_store
node_backend_app -->|"routes requests"| node_backend_api
node_backend_api -.->|"handles API data"| node_backend_db
node_backend_db -.->|"persists data"| node_postgres
node_nsfw -->|"checks images"| node_sightengine
node_item_storage -->|"builds item models"| node_game_data
node_miner_storage -->|"constructs miners"| node_game_data
node_game_events -.->|"stores event models"| node_game_data
node_crafting -.->|"uses recipe data"| node_game_data

click node_pull_runtime "https://github.com/ivaqis/arknights-tracker/blob/main/arknights-tracker/src/lib/classes/pulls/PullParser.ts"
click node_pull_stats "https://github.com/ivaqis/arknights-tracker/blob/main/arknights-tracker/src/lib/classes/pulls/PullStatsCalculator.ts"
click node_pull_storage "https://github.com/ivaqis/arknights-tracker/blob/main/arknights-tracker/src/lib/classes/pulls/PullMerger.ts"
click node_frontend_api "https://github.com/ivaqis/arknights-tracker/tree/main/arknights-tracker/src/lib/api"
click node_import_api "https://github.com/ivaqis/arknights-tracker/tree/main/arknights-tracker/src/lib/api/import"
click node_sync_api "https://github.com/ivaqis/arknights-tracker/tree/main/arknights-tracker/src/lib/api/syncPulls"
click node_global_stats "https://github.com/ivaqis/arknights-tracker/tree/main/arknights-tracker/src/lib/api/globalBannerStats"
click node_profile_api "https://github.com/ivaqis/arknights-tracker/tree/main/arknights-tracker/src/lib/api/getProfileId"
click node_game_data "https://github.com/ivaqis/arknights-tracker/tree/main/arknights-tracker/src/lib/classes/gameData"
click node_item_storage "https://github.com/ivaqis/arknights-tracker/blob/main/arknights-tracker/src/lib/classes/storages/items/ItemStorage.ts"
click node_miner_storage "https://github.com/ivaqis/arknights-tracker/blob/main/arknights-tracker/src/lib/classes/storages/buildings/MinerStorage.ts"
click node_vaporizer_storage "https://github.com/ivaqis/arknights-tracker/blob/main/arknights-tracker/src/lib/classes/storages/buildings/VaporizerStorage.ts"
click node_crafting "https://github.com/ivaqis/arknights-tracker/tree/main/arknights-tracker/src/lib/classes/searchers/recipes"
click node_game_events "https://github.com/ivaqis/arknights-tracker/blob/main/arknights-tracker/src/lib/classes/storages/events/GameEventStorage.ts"
click node_backend_app "https://github.com/ivaqis/arknights-tracker/blob/main/goyfield-backend/src/App.ts"
click node_backend_api "https://github.com/ivaqis/arknights-tracker/blob/main/goyfield-backend/src/api/controllers/Controller.ts"
click node_backend_db "https://github.com/ivaqis/arknights-tracker/tree/main/goyfield-backend/src/database"
click node_nsfw "https://github.com/ivaqis/arknights-tracker/blob/main/goyfield-backend/src/services/sightengineNsfwValidator/SightengineNsfwValidator.ts"

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_pull_runtime,node_pull_stats,node_pull_storage,node_user toneBlue
class node_frontend_api,node_import_api,node_sync_api,node_global_stats,node_profile_api toneAmber
class node_game_data,node_item_storage,node_miner_storage,node_vaporizer_storage,node_crafting,node_game_events toneMint
class node_backend_app,node_backend_api,node_backend_db,node_nsfw toneRose
class node_browser_store,node_postgres,node_sightengine toneIndigo
```

## Components

### Pull tracking

- [Pull processing](https://github.com/ivaqis/arknights-tracker/blob/main/arknights-tracker/src/lib/classes/pulls/PullParser.ts): `arknights-tracker/src/lib/classes/pulls/PullParser.ts`
- [Pull statistics](https://github.com/ivaqis/arknights-tracker/blob/main/arknights-tracker/src/lib/classes/pulls/PullStatsCalculator.ts): `arknights-tracker/src/lib/classes/pulls/PullStatsCalculator.ts`
- [Pull merging](https://github.com/ivaqis/arknights-tracker/blob/main/arknights-tracker/src/lib/classes/pulls/PullMerger.ts): `arknights-tracker/src/lib/classes/pulls/PullMerger.ts`

### API services

- [API clients](https://github.com/ivaqis/arknights-tracker/tree/main/arknights-tracker/src/lib/api): `arknights-tracker/src/lib/api`
- [Pull import](https://github.com/ivaqis/arknights-tracker/tree/main/arknights-tracker/src/lib/api/import): `arknights-tracker/src/lib/api/import`
- [Pull sync](https://github.com/ivaqis/arknights-tracker/tree/main/arknights-tracker/src/lib/api/syncPulls): `arknights-tracker/src/lib/api/syncPulls`
- [Global banner stats](https://github.com/ivaqis/arknights-tracker/tree/main/arknights-tracker/src/lib/api/globalBannerStats): `arknights-tracker/src/lib/api/globalBannerStats`
- [Profile lookup](https://github.com/ivaqis/arknights-tracker/tree/main/arknights-tracker/src/lib/api/getProfileId): `arknights-tracker/src/lib/api/getProfileId`

### Game data

- [Game data models](https://github.com/ivaqis/arknights-tracker/tree/main/arknights-tracker/src/lib/classes/gameData): `arknights-tracker/src/lib/classes/gameData`
- [Item catalog](https://github.com/ivaqis/arknights-tracker/blob/main/arknights-tracker/src/lib/classes/storages/items/ItemStorage.ts): `arknights-tracker/src/lib/classes/storages/items/ItemStorage.ts`
- [Mining buildings](https://github.com/ivaqis/arknights-tracker/blob/main/arknights-tracker/src/lib/classes/storages/buildings/MinerStorage.ts): `arknights-tracker/src/lib/classes/storages/buildings/MinerStorage.ts`
- [Vaporizer buildings](https://github.com/ivaqis/arknights-tracker/blob/main/arknights-tracker/src/lib/classes/storages/buildings/VaporizerStorage.ts): `arknights-tracker/src/lib/classes/storages/buildings/VaporizerStorage.ts`
- [Crafting recipes](https://github.com/ivaqis/arknights-tracker/tree/main/arknights-tracker/src/lib/classes/searchers/recipes): `arknights-tracker/src/lib/classes/searchers/recipes`
- [Game events](https://github.com/ivaqis/arknights-tracker/blob/main/arknights-tracker/src/lib/classes/storages/events/GameEventStorage.ts): `arknights-tracker/src/lib/classes/storages/events/GameEventStorage.ts`

### Backend services

- [HTTP application](https://github.com/ivaqis/arknights-tracker/blob/main/goyfield-backend/src/App.ts): `goyfield-backend/src/App.ts`
- [API controllers](https://github.com/ivaqis/arknights-tracker/blob/main/goyfield-backend/src/api/controllers/Controller.ts): `goyfield-backend/src/api/controllers/Controller.ts`
- [Postgres data](https://github.com/ivaqis/arknights-tracker/tree/main/goyfield-backend/src/database): `goyfield-backend/src/database`
- [Image moderation](https://github.com/ivaqis/arknights-tracker/blob/main/goyfield-backend/src/services/sightengineNsfwValidator/SightengineNsfwValidator.ts): `goyfield-backend/src/services/sightengineNsfwValidator/SightengineNsfwValidator.ts`

### External services

- **Browser local storage**
- **PostgreSQL**
- **Sightengine**

### Other components

- **Tracker user**

## Connections

- Tracker user → Pull processing: tracks pulls (evidence: `README.md`)
- Pull processing → Pull statistics: calculates stats
- Pull processing → Pull merging: merges pulls
- Tracker user → API clients: imports pulls (evidence: `README.md`)
- API clients → Pull import: uses import endpoints
- API clients → Pull sync: uses sync endpoints
- API clients → Global banner stats: requests statistics
- API clients → Profile lookup: looks up profile
- Tracker user → Browser local storage: retains pulls (evidence: `README.md`)
- HTTP application → API controllers: routes requests (evidence: `goyfield-backend/src/App.ts`)
- API controllers → Postgres data: handles API data
- Postgres data → PostgreSQL: persists data (evidence: `README.md`)
- Image moderation → Sightengine: checks images (evidence: `goyfield-backend/src/services/sightengineNsfwValidator/SightengineNsfwValidator.ts`)
- Item catalog → Game data models: builds item models (evidence: `arknights-tracker/src/lib/classes/storages/items/ItemStorage.ts`)
- Mining buildings → Game data models: constructs miners (evidence: `arknights-tracker/src/lib/classes/storages/buildings/MinerStorage.ts`)
- Game events → Game data models: stores event models
- Crafting recipes → Game data models: uses recipe data
