# akhilraj805/ai-timetable-generator architecture

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

- Interactive diagram: https://gitdiagram.com/akhilraj805/ai-timetable-generator
- Repository: https://github.com/akhilraj805/ai-timetable-generator

## Overview

This Django application generates class timetables from submitted course, teacher, lab, and reserved-slot inputs, then saves and displays the schedule or conflict details. It also exposes teacher availability endpoints and Django admin/master-data management. The sampled generation view explicitly invokes the scheduling algorithm and uses the scheduler models; the URL configuration routes requests to the views. The README gives only the product name, and the templates and several view sections were not sampled, so those links are left out rather than inferred.

Main entry points: [`miniproject/miniproject/scheduler/views.py`](https://github.com/akhilraj805/ai-timetable-generator/blob/main/miniproject/miniproject/scheduler/views.py) (Workflow handlers), [`miniproject/miniproject/scheduler/models.py`](https://github.com/akhilraj805/ai-timetable-generator/blob/main/miniproject/miniproject/scheduler/models.py) (Scheduler models), [`miniproject/miniproject/urls.py`](https://github.com/akhilraj805/ai-timetable-generator/blob/main/miniproject/miniproject/urls.py) (HTTP routes), [`miniproject/miniproject/settings.py`](https://github.com/akhilraj805/ai-timetable-generator/blob/main/miniproject/miniproject/settings.py) (Django configuration)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_web["Web workflow"]
  node_routes["HTTP routes<br/>[urls.py]"]
  node_handlers["Workflow handlers<br/>[views.py]"]
  node_input["Input form<br/>[input.html]"]
  node_results["Schedule results<br/>[result.html]"]
  node_availability_page["Availability page"]
  node_browser_controls["Form interactions<br/>[script.js]"]
end

subgraph group_scheduling["Scheduling"]
  node_generator["Timetable generator"]
end

subgraph group_data["Domain data"]
  node_entities["Scheduler models<br/>[models.py]"]
  node_sqlite[("SQLite database<br/>[db.sqlite3]")]
  node_configuration["Django configuration<br/>[settings.py]"]
end

subgraph group_operations["Data management"]
  node_admin["Admin management<br/>[admin.py]"]
  node_seed["Master-data seeding"]
end

node_user(("Scheduler user"))

node_user -.->|"sends requests"| node_routes
node_routes -->|"routes requests"| node_handlers
node_handlers -->|"generates schedule"| node_generator
node_handlers -->|"reads and writes"| node_entities
node_handlers -->|"renders result"| node_results
node_configuration -->|"configures store"| node_sqlite
node_admin -->|"manages records"| node_entities
node_seed -->|"seeds records"| node_entities

click node_routes "https://github.com/akhilraj805/ai-timetable-generator/blob/main/miniproject/miniproject/urls.py"
click node_handlers "https://github.com/akhilraj805/ai-timetable-generator/blob/main/miniproject/miniproject/scheduler/views.py"
click node_input "https://github.com/akhilraj805/ai-timetable-generator/blob/main/miniproject/miniproject/templates/input.html"
click node_results "https://github.com/akhilraj805/ai-timetable-generator/blob/main/miniproject/miniproject/templates/result.html"
click node_availability_page "https://github.com/akhilraj805/ai-timetable-generator/blob/main/miniproject/miniproject/templates/teacher_availability.html"
click node_browser_controls "https://github.com/akhilraj805/ai-timetable-generator/blob/main/miniproject/miniproject/static/js/script.js"
click node_generator "https://github.com/akhilraj805/ai-timetable-generator/blob/main/miniproject/miniproject/scheduler/timetable_algorithm.py"
click node_entities "https://github.com/akhilraj805/ai-timetable-generator/blob/main/miniproject/miniproject/scheduler/models.py"
click node_sqlite "https://github.com/akhilraj805/ai-timetable-generator/blob/main/miniproject/db.sqlite3"
click node_configuration "https://github.com/akhilraj805/ai-timetable-generator/blob/main/miniproject/miniproject/settings.py"
click node_admin "https://github.com/akhilraj805/ai-timetable-generator/blob/main/miniproject/miniproject/scheduler/admin.py"
click node_seed "https://github.com/akhilraj805/ai-timetable-generator/blob/main/miniproject/miniproject/scheduler/management/commands/seed_cs_master_data.py"

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_routes,node_handlers,node_input,node_results,node_availability_page,node_browser_controls toneBlue
class node_generator toneAmber
class node_entities,node_sqlite,node_configuration toneMint
class node_admin,node_seed,node_user toneRose
```

## Components

### Web workflow

- [HTTP routes](https://github.com/akhilraj805/ai-timetable-generator/blob/main/miniproject/miniproject/urls.py): `miniproject/miniproject/urls.py`
- [Workflow handlers](https://github.com/akhilraj805/ai-timetable-generator/blob/main/miniproject/miniproject/scheduler/views.py): `miniproject/miniproject/scheduler/views.py`
- [Input form](https://github.com/akhilraj805/ai-timetable-generator/blob/main/miniproject/miniproject/templates/input.html): `miniproject/miniproject/templates/input.html`
- [Schedule results](https://github.com/akhilraj805/ai-timetable-generator/blob/main/miniproject/miniproject/templates/result.html): `miniproject/miniproject/templates/result.html`
- [Availability page](https://github.com/akhilraj805/ai-timetable-generator/blob/main/miniproject/miniproject/templates/teacher_availability.html): `miniproject/miniproject/templates/teacher_availability.html`
- [Form interactions](https://github.com/akhilraj805/ai-timetable-generator/blob/main/miniproject/miniproject/static/js/script.js): `miniproject/miniproject/static/js/script.js`

### Scheduling

- [Timetable generator](https://github.com/akhilraj805/ai-timetable-generator/blob/main/miniproject/miniproject/scheduler/timetable_algorithm.py): `miniproject/miniproject/scheduler/timetable_algorithm.py`

### Domain data

- [Scheduler models](https://github.com/akhilraj805/ai-timetable-generator/blob/main/miniproject/miniproject/scheduler/models.py): `miniproject/miniproject/scheduler/models.py`
- [SQLite database](https://github.com/akhilraj805/ai-timetable-generator/blob/main/miniproject/db.sqlite3): `miniproject/db.sqlite3`
- [Django configuration](https://github.com/akhilraj805/ai-timetable-generator/blob/main/miniproject/miniproject/settings.py): `miniproject/miniproject/settings.py`

### Data management

- [Admin management](https://github.com/akhilraj805/ai-timetable-generator/blob/main/miniproject/miniproject/scheduler/admin.py): `miniproject/miniproject/scheduler/admin.py`
- [Master-data seeding](https://github.com/akhilraj805/ai-timetable-generator/blob/main/miniproject/miniproject/scheduler/management/commands/seed_cs_master_data.py): `miniproject/miniproject/scheduler/management/commands/seed_cs_master_data.py`

### Other components

- **Scheduler user**

## Connections

- Scheduler user → HTTP routes: sends requests
- HTTP routes → Workflow handlers: routes requests (evidence: `miniproject/miniproject/urls.py`)
- Workflow handlers → Timetable generator: generates schedule (evidence: `miniproject/miniproject/scheduler/views.py`)
- Workflow handlers → Scheduler models: reads and writes (evidence: `miniproject/miniproject/scheduler/views.py`)
- Workflow handlers → Schedule results: renders result (evidence: `miniproject/miniproject/scheduler/views.py`)
- Django configuration → SQLite database: configures store (evidence: `miniproject/miniproject/settings.py`)
- Admin management → Scheduler models: manages records (evidence: `miniproject/miniproject/scheduler/admin.py`)
- Master-data seeding → Scheduler models: seeds records (evidence: `miniproject/miniproject/scheduler/management/commands/seed_cs_master_data.py`)
