# devikark049/ai-assignement-assistent architecture

> Architecture diagram of the GitHub repository devikark049/ai-assignement-assistent, 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/devikark049/ai-assignement-assistent
- Repository: https://github.com/devikark049/ai-assignement-assistent

## Overview

This is a browser-based AI assignment assistant backed by a FastAPI service and a local Ollama model. The main workflow collects assignment settings, requests an answer, and displays structured results. Separate branches support model health checks, document uploads and text extraction, and study-note generation. The excerpts show the key route and helper relationships; frontend markup and some implementation details are unsampled, so the graph omits those connections rather than inferring them.

Main entry points: [`backend/main.py`](https://github.com/devikark049/ai-assignement-assistent/blob/main/backend/main.py) (FastAPI service), [`frontend/app.js`](https://github.com/devikark049/ai-assignement-assistent/blob/main/frontend/app.js) (Assignment interface)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_frontend["Browser interface"]
  node_browser["Assignment interface<br/>[app.js]"]
end

subgraph group_service["API and documents"]
  node_api["FastAPI service<br/>[main.py]"]
  node_health["Model health check<br/>[main.py]"]
  node_upload["Upload handler<br/>[main.py]"]
  node_extract["Document text extraction<br/>[main.py]"]
  node_files["Uploaded files<br/>[main.py]"]
end

subgraph group_generation["AI generation"]
  node_answer["Answer workflow<br/>[main.py]"]
  node_prompt["Assignment prompt<br/>[main.py]"]
  node_json["JSON extraction<br/>[main.py]"]
  node_notes["Study notes<br/>[main.py]"]
end

node_student(("Student"))
node_ollama["Ollama model"]

node_student -->|"submits question"| node_browser
node_browser -->|"requests answer"| node_api
node_api -->|"routes request"| node_answer
node_answer -->|"builds prompt"| node_prompt
node_answer -->|"requests generation"| node_ollama
node_answer -->|"parses response"| node_json
node_browser -->|"checks health"| node_api
node_api -->|"routes check"| node_health
node_health -->|"checks models"| node_ollama
node_browser -->|"uploads document"| node_api
node_api -->|"routes upload"| node_upload
node_upload -->|"writes file"| node_files
node_upload -->|"extracts text"| node_extract
node_browser -->|"requests notes"| node_api
node_api -->|"routes notes"| node_notes
node_notes -->|"requests generation"| node_ollama

click node_browser "https://github.com/devikark049/ai-assignement-assistent/blob/main/frontend/app.js"
click node_api "https://github.com/devikark049/ai-assignement-assistent/blob/main/backend/main.py"
click node_answer "https://github.com/devikark049/ai-assignement-assistent/blob/main/backend/main.py"
click node_prompt "https://github.com/devikark049/ai-assignement-assistent/blob/main/backend/main.py"
click node_json "https://github.com/devikark049/ai-assignement-assistent/blob/main/backend/main.py"
click node_health "https://github.com/devikark049/ai-assignement-assistent/blob/main/backend/main.py"
click node_upload "https://github.com/devikark049/ai-assignement-assistent/blob/main/backend/main.py"
click node_extract "https://github.com/devikark049/ai-assignement-assistent/blob/main/backend/main.py"
click node_files "https://github.com/devikark049/ai-assignement-assistent/blob/main/backend/main.py"
click node_notes "https://github.com/devikark049/ai-assignement-assistent/blob/main/backend/main.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_browser toneBlue
class node_api,node_health,node_upload,node_extract,node_files toneAmber
class node_answer,node_prompt,node_json,node_notes toneMint
class node_student,node_ollama toneIndigo
```

## Components

### Browser interface

- [Assignment interface](https://github.com/devikark049/ai-assignement-assistent/blob/main/frontend/app.js): `frontend/app.js`

### API and documents

- [FastAPI service](https://github.com/devikark049/ai-assignement-assistent/blob/main/backend/main.py): `backend/main.py`
- [Model health check](https://github.com/devikark049/ai-assignement-assistent/blob/main/backend/main.py): `backend/main.py`
- [Upload handler](https://github.com/devikark049/ai-assignement-assistent/blob/main/backend/main.py): `backend/main.py`
- [Document text extraction](https://github.com/devikark049/ai-assignement-assistent/blob/main/backend/main.py): `backend/main.py`
- [Uploaded files](https://github.com/devikark049/ai-assignement-assistent/blob/main/backend/main.py): `backend/main.py`

### AI generation

- [Answer workflow](https://github.com/devikark049/ai-assignement-assistent/blob/main/backend/main.py): `backend/main.py`
- [Assignment prompt](https://github.com/devikark049/ai-assignement-assistent/blob/main/backend/main.py): `backend/main.py`
- [JSON extraction](https://github.com/devikark049/ai-assignement-assistent/blob/main/backend/main.py): `backend/main.py`
- [Study notes](https://github.com/devikark049/ai-assignement-assistent/blob/main/backend/main.py): `backend/main.py`

### Other components

- **Student**
- **Ollama model**

## Connections

- Student → Assignment interface: submits question (evidence: `frontend/app.js`)
- Assignment interface → FastAPI service: requests answer (evidence: `frontend/app.js`)
- FastAPI service → Answer workflow: routes request (evidence: `backend/main.py`)
- Answer workflow → Assignment prompt: builds prompt (evidence: `backend/main.py`)
- Answer workflow → Ollama model: requests generation (evidence: `backend/main.py`)
- Answer workflow → JSON extraction: parses response (evidence: `backend/main.py`)
- Assignment interface → FastAPI service: checks health (evidence: `frontend/app.js`)
- FastAPI service → Model health check: routes check (evidence: `backend/main.py`)
- Model health check → Ollama model: checks models (evidence: `backend/main.py`)
- Assignment interface → FastAPI service: uploads document (evidence: `frontend/app.js`)
- FastAPI service → Upload handler: routes upload (evidence: `backend/main.py`)
- Upload handler → Uploaded files: writes file (evidence: `backend/main.py`)
- Upload handler → Document text extraction: extracts text (evidence: `backend/main.py`)
- Assignment interface → FastAPI service: requests notes (evidence: `frontend/app.js`)
- FastAPI service → Study notes: routes notes (evidence: `backend/main.py`)
- Study notes → Ollama model: requests generation (evidence: `backend/main.py`)
