# afiabroti/cholokuet architecture

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

- Interactive diagram: https://gitdiagram.com/afiabroti/cholokuet
- Repository: https://github.com/afiabroti/cholokuet

## Overview

CholoKUET is an offline terminal navigator for KUET. A visitor signs in, chooses a starting point and destination, and receives walking directions; the app also supports nearby-place discovery and campus exploration. Supporting branches cover search and browsing, account-specific preferences and trip history, and administrator management. The graph reflects README-documented capabilities and the supplied source index; several implementation files were indexed as read but their code was not excerpted here, so uncertain call relationships are omitted.

Main entry points: [`include/Navigator.h`](https://github.com/afiabroti/cholokuet/blob/main/include/Navigator.h) (Navigator menus), [`src/Campus.cpp`](https://github.com/afiabroti/cholokuet/blob/main/src/Campus.cpp) (Campus data), [`src/Places.cpp`](https://github.com/afiabroti/cholokuet/blob/main/src/Places.cpp) (Place and user menus), [`src/NavigatorAdmin.cpp`](https://github.com/afiabroti/cholokuet/blob/main/src/NavigatorAdmin.cpp) (Admin management)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_app["Application"]
  node_entry["Program entry<br/>[main.cpp]"]
  node_navigator["Navigator menus<br/>[Navigator.h]"]
  node_auth["Authentication<br/>[Authentication.cpp]"]
  node_users[("User accounts<br/>[users.txt]")]
end

subgraph group_campus["Campus model"]
  node_campus_model["Campus data<br/>[Campus.cpp]"]
  node_locations[("Places<br/>[locations.txt]")]
  node_walkways[("Walkways<br/>[paths.txt]")]
  node_categories[("Categories<br/>[categories.txt]")]
  node_graph["Walkway graph<br/>[Graph.cpp]"]
  node_queue["BFS queue<br/>[Queue.cpp]"]
  node_trip["Route directions<br/>[Trips.cpp]"]
  node_nearby["Nearby and DFS<br/>[Navigator.h]"]
end

subgraph group_discovery["Place discovery"]
  node_search["Place search<br/>[Search.cpp]"]
  node_tree["Category browsing<br/>[CampusTree.cpp]"]
  node_sorting["Place sorting<br/>[Sort.cpp]"]
  node_place_menus["Place and user menus<br/>[Places.cpp]"]
end

subgraph group_state["User state"]
  node_stack["History stack<br/>[Stack.cpp]"]
  node_favorites[("Saved favorites<br/>[favorites.txt]")]
end

subgraph group_admin["Administration"]
  node_admin["Admin management<br/>[NavigatorAdmin.cpp]"]
  node_logger["Activity log<br/>[Logger.cpp]"]
end

node_visitor(("Visitor"))

node_visitor -->|"starts app"| node_entry
node_entry -->|"initializes and runs"| node_navigator
node_navigator -->|"handles sign-in"| node_auth
node_auth -->|"loads and saves"| node_users
node_navigator -->|"loads campus"| node_campus_model
node_campus_model -->|"loads and saves"| node_locations
node_campus_model -->|"loads and saves"| node_walkways
node_campus_model -->|"loads"| node_categories
node_campus_model -->|"uses graph"| node_graph
node_graph -->|"runs BFS"| node_queue
node_navigator -->|"requests directions"| node_trip
node_trip -->|"uses campus routes"| node_campus_model
node_visitor -->|"chooses destination"| node_navigator
node_navigator -->|"offers nearby and explore"| node_nearby
node_navigator -->|"opens place menus"| node_place_menus
node_place_menus -->|"searches places"| node_search
node_place_menus -->|"browses categories"| node_tree
node_place_menus -->|"sorts places"| node_sorting
node_navigator -->|"tracks trip history"| node_stack
node_place_menus -->|"saves favorites"| node_favorites
node_navigator -->|"dispatches admin actions"| node_admin
node_admin -->|"manages places and walkways"| node_campus_model
node_admin -->|"views activity log"| node_logger

click node_entry "https://github.com/afiabroti/cholokuet/blob/main/main.cpp"
click node_navigator "https://github.com/afiabroti/cholokuet/blob/main/include/Navigator.h"
click node_auth "https://github.com/afiabroti/cholokuet/blob/main/src/Authentication.cpp"
click node_users "https://github.com/afiabroti/cholokuet/blob/main/data/users.txt"
click node_campus_model "https://github.com/afiabroti/cholokuet/blob/main/src/Campus.cpp"
click node_locations "https://github.com/afiabroti/cholokuet/blob/main/data/locations.txt"
click node_walkways "https://github.com/afiabroti/cholokuet/blob/main/data/paths.txt"
click node_categories "https://github.com/afiabroti/cholokuet/blob/main/data/categories.txt"
click node_graph "https://github.com/afiabroti/cholokuet/blob/main/src/Graph.cpp"
click node_queue "https://github.com/afiabroti/cholokuet/blob/main/dsa/queue/Queue.cpp"
click node_stack "https://github.com/afiabroti/cholokuet/blob/main/dsa/stack/Stack.cpp"
click node_trip "https://github.com/afiabroti/cholokuet/blob/main/src/Trips.cpp"
click node_nearby "https://github.com/afiabroti/cholokuet/blob/main/include/Navigator.h"
click node_search "https://github.com/afiabroti/cholokuet/blob/main/src/Search.cpp"
click node_tree "https://github.com/afiabroti/cholokuet/blob/main/src/CampusTree.cpp"
click node_sorting "https://github.com/afiabroti/cholokuet/blob/main/src/Sort.cpp"
click node_place_menus "https://github.com/afiabroti/cholokuet/blob/main/src/Places.cpp"
click node_favorites "https://github.com/afiabroti/cholokuet/blob/main/data/favorites.txt"
click node_admin "https://github.com/afiabroti/cholokuet/blob/main/src/NavigatorAdmin.cpp"
click node_logger "https://github.com/afiabroti/cholokuet/blob/main/src/Logger.cpp"

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_entry,node_navigator,node_auth,node_users toneBlue
class node_campus_model,node_locations,node_walkways,node_categories,node_graph,node_queue,node_trip,node_nearby toneAmber
class node_search,node_tree,node_sorting,node_place_menus toneMint
class node_stack,node_favorites toneRose
class node_admin,node_logger,node_visitor toneIndigo
```

## Components

### Application

- [Program entry](https://github.com/afiabroti/cholokuet/blob/main/main.cpp): `main.cpp`
- [Navigator menus](https://github.com/afiabroti/cholokuet/blob/main/include/Navigator.h): `include/Navigator.h`
- [Authentication](https://github.com/afiabroti/cholokuet/blob/main/src/Authentication.cpp): `src/Authentication.cpp`
- [User accounts](https://github.com/afiabroti/cholokuet/blob/main/data/users.txt): `data/users.txt`

### Campus model

- [Campus data](https://github.com/afiabroti/cholokuet/blob/main/src/Campus.cpp): `src/Campus.cpp`
- [Places](https://github.com/afiabroti/cholokuet/blob/main/data/locations.txt): `data/locations.txt`
- [Walkways](https://github.com/afiabroti/cholokuet/blob/main/data/paths.txt): `data/paths.txt`
- [Categories](https://github.com/afiabroti/cholokuet/blob/main/data/categories.txt): `data/categories.txt`
- [Walkway graph](https://github.com/afiabroti/cholokuet/blob/main/src/Graph.cpp): `src/Graph.cpp`
- [BFS queue](https://github.com/afiabroti/cholokuet/blob/main/dsa/queue/Queue.cpp): `dsa/queue/Queue.cpp`
- [Route directions](https://github.com/afiabroti/cholokuet/blob/main/src/Trips.cpp): `src/Trips.cpp`
- [Nearby and DFS](https://github.com/afiabroti/cholokuet/blob/main/include/Navigator.h): `include/Navigator.h`

### Place discovery

- [Place search](https://github.com/afiabroti/cholokuet/blob/main/src/Search.cpp): `src/Search.cpp`
- [Category browsing](https://github.com/afiabroti/cholokuet/blob/main/src/CampusTree.cpp): `src/CampusTree.cpp`
- [Place sorting](https://github.com/afiabroti/cholokuet/blob/main/src/Sort.cpp): `src/Sort.cpp`
- [Place and user menus](https://github.com/afiabroti/cholokuet/blob/main/src/Places.cpp): `src/Places.cpp`

### User state

- [History stack](https://github.com/afiabroti/cholokuet/blob/main/dsa/stack/Stack.cpp): `dsa/stack/Stack.cpp`
- [Saved favorites](https://github.com/afiabroti/cholokuet/blob/main/data/favorites.txt): `data/favorites.txt`

### Administration

- [Admin management](https://github.com/afiabroti/cholokuet/blob/main/src/NavigatorAdmin.cpp): `src/NavigatorAdmin.cpp`
- [Activity log](https://github.com/afiabroti/cholokuet/blob/main/src/Logger.cpp): `src/Logger.cpp`

### Other components

- **Visitor**

## Connections

- Visitor → Program entry: starts app (evidence: `README.md`)
- Program entry → Navigator menus: initializes and runs (evidence: `main.cpp`)
- Navigator menus → Authentication: handles sign-in (evidence: `include/Navigator.h`)
- Authentication → User accounts: loads and saves (evidence: `src/Authentication.cpp`)
- Navigator menus → Campus data: loads campus
- Campus data → Places: loads and saves (evidence: `src/Campus.cpp`)
- Campus data → Walkways: loads and saves (evidence: `src/Campus.cpp`)
- Campus data → Categories: loads (evidence: `src/Campus.cpp`)
- Campus data → Walkway graph: uses graph
- Walkway graph → BFS queue: runs BFS (evidence: `src/Graph.cpp`)
- Navigator menus → Route directions: requests directions (evidence: `include/Navigator.h`)
- Route directions → Campus data: uses campus routes
- Visitor → Navigator menus: chooses destination (evidence: `README.md`)
- Navigator menus → Nearby and DFS: offers nearby and explore (evidence: `README.md`)
- Navigator menus → Place and user menus: opens place menus (evidence: `include/Navigator.h`)
- Place and user menus → Place search: searches places (evidence: `src/Places.cpp`)
- Place and user menus → Category browsing: browses categories (evidence: `README.md`)
- Place and user menus → Place sorting: sorts places (evidence: `src/Places.cpp`)
- Navigator menus → History stack: tracks trip history (evidence: `include/Navigator.h`)
- Place and user menus → Saved favorites: saves favorites (evidence: `src/Places.cpp`)
- Navigator menus → Admin management: dispatches admin actions (evidence: `include/Navigator.h`)
- Admin management → Campus data: manages places and walkways (evidence: `README.md`)
- Admin management → Activity log: views activity log
