# bakshi67/hackathon_eval architecture

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

## Overview

This is a Frappe-based hackathon evaluation system. Its main workflow enrolls teams, records Level 1 reviews and shortlists teams, assigns mentors for Level 2 scoring, recomputes rankings, and supports regional/final selection and standings. Settings govern scoring limits and selection counts; permissions restrict reviewers and mentors. The control panel and reports expose administrative progress and results. Some API and UI excerpts are incomplete, so unverified links are omitted or shown as dashed rather than inferred.

Main entry points: [`hackathon_eval/hackathon_eval/doctype/hackathon_team/hackathon_team.py`](https://github.com/bakshi67/hackathon_eval/blob/main/hackathon_eval/hackathon_eval/doctype/hackathon_team/hackathon_team.py) (Hackathon Teams), [`hackathon_eval/hackathon_eval/page/hackathon_control_pa/hackathon_control_pa.js`](https://github.com/bakshi67/hackathon_eval/blob/main/hackathon_eval/hackathon_eval/page/hackathon_control_pa/hackathon_control_pa.js) (Control Panel), [`hackathon_eval/hackathon_eval/doctype/l2_evaluation/l2_evaluation.py`](https://github.com/bakshi67/hackathon_eval/blob/main/hackathon_eval/hackathon_eval/doctype/l2_evaluation/l2_evaluation.py) (L2 Evaluations), [`hackathon_eval/hackathon_eval/doctype/hackathon_settings/hackathon_settings.py`](https://github.com/bakshi67/hackathon_eval/blob/main/hackathon_eval/hackathon_eval/doctype/hackathon_settings/hackathon_settings.py) (Scoring Settings)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_admin["Administration"]
  node_control["Control Panel"]
  node_settings["Scoring Settings"]
  node_seed["Demo Data Seed<br/>[seed.py]"]
end

subgraph group_evaluation["Evaluation Stages"]
  node_team_import["Team Import<br/>[api.py]"]
  node_l1["L1 Shortlisting<br/>[api.py]"]
  node_mentor_assignment["Mentor Assignment<br/>[api.py]"]
  node_l2_recompute["L2 Scoring and Ranks<br/>[api.py]"]
  node_final_selection["Final Selection<br/>[api.py]"]
end

subgraph group_records["Domain Records"]
  node_team[("Hackathon Teams<br/>[hackathon_team.py]")]
  node_l1_review[("L1 Reviews<br/>[l1_review.py]")]
  node_l2_evaluation[("L2 Evaluations<br/>[l2_evaluation.py]")]
  node_mentor_records[("Mentor Records<br/>[mentor.py]")]
end

subgraph group_insights["Access and Reporting"]
  node_permissions["Role Permissions<br/>[permissions.py]"]
  node_reports["Evaluation Reports"]
end

node_admin_actor(("Hackathon Admin"))
node_reviewer_actor(("L1 Reviewer"))
node_mentor_actor(("Mentor"))

node_l1_review -->|"reads limits"| node_settings
node_l1_review -->|"updates scores"| node_team
node_l2_evaluation -->|"reads limits"| node_settings
node_l2_evaluation -->|"checks assignment"| node_mentor_assignment
node_l2_evaluation -->|"updates status"| node_team
node_l2_evaluation -->|"triggers recompute"| node_l2_recompute
node_team -->|"reads score limits"| node_settings
node_team_import -->|"creates or updates"| node_team
node_l1 -->|"sets shortlist status"| node_team
node_l2_recompute -->|"writes score totals"| node_team
node_final_selection -->|"reads finalist count"| node_settings
node_final_selection -->|"writes final ranks"| node_team
node_control -.->|"invokes"| node_team_import
node_control -.->|"invokes"| node_l1
node_control -.->|"invokes"| node_mentor_assignment
node_control -.->|"invokes"| node_l2_recompute
node_control -.->|"invokes"| node_final_selection
node_seed -->|"configures"| node_settings
node_seed -->|"uses evaluation API"| node_team_import
node_permissions -.->|"restricts access"| node_l1_review
node_permissions -.->|"restricts access"| node_l2_evaluation
node_permissions -.->|"restricts access"| node_mentor_assignment

click node_control "https://github.com/bakshi67/hackathon_eval/blob/main/hackathon_eval/hackathon_eval/page/hackathon_control_pa/hackathon_control_pa.js"
click node_settings "https://github.com/bakshi67/hackathon_eval/blob/main/hackathon_eval/hackathon_eval/doctype/hackathon_settings/hackathon_settings.py"
click node_team_import "https://github.com/bakshi67/hackathon_eval/blob/main/hackathon_eval/api.py"
click node_l1 "https://github.com/bakshi67/hackathon_eval/blob/main/hackathon_eval/api.py"
click node_mentor_assignment "https://github.com/bakshi67/hackathon_eval/blob/main/hackathon_eval/api.py"
click node_l2_recompute "https://github.com/bakshi67/hackathon_eval/blob/main/hackathon_eval/api.py"
click node_final_selection "https://github.com/bakshi67/hackathon_eval/blob/main/hackathon_eval/api.py"
click node_team "https://github.com/bakshi67/hackathon_eval/blob/main/hackathon_eval/hackathon_eval/doctype/hackathon_team/hackathon_team.py"
click node_l1_review "https://github.com/bakshi67/hackathon_eval/blob/main/hackathon_eval/hackathon_eval/doctype/l1_review/l1_review.py"
click node_l2_evaluation "https://github.com/bakshi67/hackathon_eval/blob/main/hackathon_eval/hackathon_eval/doctype/l2_evaluation/l2_evaluation.py"
click node_mentor_records "https://github.com/bakshi67/hackathon_eval/blob/main/hackathon_eval/hackathon_eval/doctype/mentor/mentor.py"
click node_permissions "https://github.com/bakshi67/hackathon_eval/blob/main/hackathon_eval/permissions.py"
click node_reports "https://github.com/bakshi67/hackathon_eval/tree/main/hackathon_eval/hackathon_eval/report"
click node_seed "https://github.com/bakshi67/hackathon_eval/blob/main/hackathon_eval/seed.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_control,node_settings,node_seed,node_reviewer_actor toneBlue
class node_team_import,node_l1,node_mentor_assignment,node_l2_recompute,node_final_selection toneAmber
class node_team,node_l1_review,node_l2_evaluation,node_mentor_records toneMint
class node_permissions,node_reports toneRose
class node_admin_actor,node_mentor_actor toneIndigo
```

## Components

### Administration

- [Control Panel](https://github.com/bakshi67/hackathon_eval/blob/main/hackathon_eval/hackathon_eval/page/hackathon_control_pa/hackathon_control_pa.js): `hackathon_eval/hackathon_eval/page/hackathon_control_pa/hackathon_control_pa.js`
- [Scoring Settings](https://github.com/bakshi67/hackathon_eval/blob/main/hackathon_eval/hackathon_eval/doctype/hackathon_settings/hackathon_settings.py): `hackathon_eval/hackathon_eval/doctype/hackathon_settings/hackathon_settings.py`
- [Demo Data Seed](https://github.com/bakshi67/hackathon_eval/blob/main/hackathon_eval/seed.py): `hackathon_eval/seed.py`

### Evaluation Stages

- [Team Import](https://github.com/bakshi67/hackathon_eval/blob/main/hackathon_eval/api.py): `hackathon_eval/api.py`
- [L1 Shortlisting](https://github.com/bakshi67/hackathon_eval/blob/main/hackathon_eval/api.py): `hackathon_eval/api.py`
- [Mentor Assignment](https://github.com/bakshi67/hackathon_eval/blob/main/hackathon_eval/api.py): `hackathon_eval/api.py`
- [L2 Scoring and Ranks](https://github.com/bakshi67/hackathon_eval/blob/main/hackathon_eval/api.py): `hackathon_eval/api.py`
- [Final Selection](https://github.com/bakshi67/hackathon_eval/blob/main/hackathon_eval/api.py): `hackathon_eval/api.py`

### Domain Records

- [Hackathon Teams](https://github.com/bakshi67/hackathon_eval/blob/main/hackathon_eval/hackathon_eval/doctype/hackathon_team/hackathon_team.py): `hackathon_eval/hackathon_eval/doctype/hackathon_team/hackathon_team.py`
- [L1 Reviews](https://github.com/bakshi67/hackathon_eval/blob/main/hackathon_eval/hackathon_eval/doctype/l1_review/l1_review.py): `hackathon_eval/hackathon_eval/doctype/l1_review/l1_review.py`
- [L2 Evaluations](https://github.com/bakshi67/hackathon_eval/blob/main/hackathon_eval/hackathon_eval/doctype/l2_evaluation/l2_evaluation.py): `hackathon_eval/hackathon_eval/doctype/l2_evaluation/l2_evaluation.py`
- [Mentor Records](https://github.com/bakshi67/hackathon_eval/blob/main/hackathon_eval/hackathon_eval/doctype/mentor/mentor.py): `hackathon_eval/hackathon_eval/doctype/mentor/mentor.py`

### Access and Reporting

- [Role Permissions](https://github.com/bakshi67/hackathon_eval/blob/main/hackathon_eval/permissions.py): `hackathon_eval/permissions.py`
- [Evaluation Reports](https://github.com/bakshi67/hackathon_eval/tree/main/hackathon_eval/hackathon_eval/report): `hackathon_eval/hackathon_eval/report`

### Other components

- **Hackathon Admin**
- **L1 Reviewer**
- **Mentor**

## Connections

- L1 Reviews → Scoring Settings: reads limits (evidence: `hackathon_eval/hackathon_eval/doctype/l1_review/l1_review.py`)
- L1 Reviews → Hackathon Teams: updates scores (evidence: `hackathon_eval/hackathon_eval/doctype/l1_review/l1_review.py`)
- L2 Evaluations → Scoring Settings: reads limits (evidence: `hackathon_eval/hackathon_eval/doctype/l2_evaluation/l2_evaluation.py`)
- L2 Evaluations → Mentor Assignment: checks assignment (evidence: `hackathon_eval/hackathon_eval/doctype/l2_evaluation/l2_evaluation.py`)
- L2 Evaluations → Hackathon Teams: updates status (evidence: `hackathon_eval/hackathon_eval/doctype/l2_evaluation/l2_evaluation.py`)
- L2 Evaluations → L2 Scoring and Ranks: triggers recompute (evidence: `hackathon_eval/hackathon_eval/doctype/l2_evaluation/l2_evaluation.py`)
- Hackathon Teams → Scoring Settings: reads score limits (evidence: `hackathon_eval/hackathon_eval/doctype/hackathon_team/hackathon_team.py`)
- Team Import → Hackathon Teams: creates or updates (evidence: `hackathon_eval/api.py`)
- L1 Shortlisting → Hackathon Teams: sets shortlist status (evidence: `hackathon_eval/api.py`)
- L2 Scoring and Ranks → Hackathon Teams: writes score totals (evidence: `hackathon_eval/api.py`)
- Final Selection → Scoring Settings: reads finalist count (evidence: `hackathon_eval/api.py`)
- Final Selection → Hackathon Teams: writes final ranks (evidence: `hackathon_eval/api.py`)
- Control Panel → Team Import: invokes
- Control Panel → L1 Shortlisting: invokes
- Control Panel → Mentor Assignment: invokes
- Control Panel → L2 Scoring and Ranks: invokes
- Control Panel → Final Selection: invokes
- Demo Data Seed → Scoring Settings: configures (evidence: `hackathon_eval/seed.py`)
- Demo Data Seed → Team Import: uses evaluation API (evidence: `hackathon_eval/seed.py`)
- Role Permissions → L1 Reviews: restricts access
- Role Permissions → L2 Evaluations: restricts access
- Role Permissions → Mentor Assignment: restricts access (evidence: `hackathon_eval/api.py`)
