# ledat0105-na/study-assistant architecture

> Architecture diagram of the GitHub repository ledat0105-na/study-assistant, 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/ledat0105-na/study-assistant
- Repository: https://github.com/ledat0105-na/study-assistant

## Overview

This is a Spring Boot AI study assistant for students and administrators. The student workflow centers on document upload and AI analysis, followed by document-grounded chat and study tools; users can also track progress and manage subscriptions. Admins manage users, pricing, payments, documents, and audit activity. The tree and README document these capabilities, but no backend implementation excerpts were supplied, so most API-to-service and persistence links are omitted rather than inferred. The shown frontend excerpts support only the sidebar/logout, localization, and citation behavior.

Main entry points: [`src/main/resources/static`](https://github.com/ledat0105-na/study-assistant/tree/main/src/main/resources/static) (Study pages), [`src/main/java/com/example/studyassistant/repository`](https://github.com/ledat0105-na/study-assistant/tree/main/src/main/java/com/example/studyassistant/repository) (Repositories), [`src/main/java/com/example/studyassistant/controller/DocumentController.java`](https://github.com/ledat0105-na/study-assistant/blob/main/src/main/java/com/example/studyassistant/controller/DocumentController.java) (Document management), [`src/main/java/com/example/studyassistant/service/DocumentService.java`](https://github.com/ledat0105-na/study-assistant/blob/main/src/main/java/com/example/studyassistant/service/DocumentService.java) (Document analysis)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_student["Student learning"]
end

subgraph group_admin["Administration"]
  node_admin_ops["Admin operations"]
end

subgraph group_backend["Backend services"]
  node_application["Spring application"]
  node_auth["Authentication"]
  node_user_service["User service<br/>[UserService.java]"]
  node_documents["Document management"]
  node_document_service["Document analysis"]
  node_ai["AI integration<br/>[AiService.java]"]
  node_chat["AI study chat"]
  node_chat_service["Chat service<br/>[ChatService.java]"]
  node_study_tools["Quiz and flashcards"]
  node_topics["Knowledge topics"]
  node_progress["Learning progress"]
  node_subscriptions["Plans and payments"]
  node_quota["Usage quotas<br/>[QuotaService.java]"]
  node_ai_provider["OpenAI / LLM"]
end

subgraph group_data["Persistent data"]
  node_entities["Domain entities"]
  node_repositories["Repositories"]
  node_database[("MySQL database")]
  node_uploads[("Private uploads")]
end

subgraph group_frontend["Web interface"]
  node_study_ui["Study pages"]
  node_sidebar["Sidebar and logout<br/>[sidebar.js]"]
  node_translations["UI translations<br/>[i18n.js]"]
  node_citations["Citation links<br/>[citations.js]"]
  node_session_fetch["Session fetch wrapper"]
end

node_student(("Student"))
node_admin_actor(("Administrator"))

node_student -->|"uses"| node_study_ui
node_admin_actor -->|"uses"| node_study_ui
node_study_ui -.->|"authenticates"| node_auth
node_study_ui -.->|"uploads documents"| node_documents
node_study_ui -.->|"asks questions"| node_chat
node_study_ui -.->|"studies with"| node_study_tools
node_study_ui -.->|"views maps"| node_topics
node_study_ui -.->|"views progress"| node_progress
node_study_ui -.->|"manages plans"| node_subscriptions
node_study_ui -.->|"administers"| node_admin_ops
node_study_ui -->|"localizes"| node_translations
node_study_ui -.->|"renders navigation"| node_sidebar
node_study_ui -.->|"renders citations"| node_citations
node_sidebar -->|"posts logout"| node_auth
node_study_ui -.->|"wraps fetch"| node_session_fetch
node_application -.->|"serves routes"| node_auth
node_documents -.->|"delegates"| node_document_service
node_document_service -.->|"analyzes with"| node_ai
node_chat -.->|"delegates"| node_chat_service
node_chat_service -.->|"queries"| node_ai
node_ai -.->|"calls model"| node_ai_provider
node_documents -.->|"stores files"| node_uploads
node_user_service -.->|"accesses"| node_repositories
node_document_service -.->|"accesses"| node_repositories
node_chat_service -.->|"accesses"| node_repositories
node_study_tools -.->|"accesses"| node_repositories
node_topics -.->|"accesses"| node_repositories
node_progress -.->|"accesses"| node_repositories
node_subscriptions -.->|"accesses"| node_repositories
node_admin_ops -.->|"accesses"| node_repositories
node_quota -.->|"accesses"| node_repositories
node_repositories -.->|"maps records"| node_entities
node_repositories -.->|"persists"| node_database
node_subscriptions -.->|"enforces limits"| node_quota

click node_study_ui "https://github.com/ledat0105-na/study-assistant/tree/main/src/main/resources/static"
click node_sidebar "https://github.com/ledat0105-na/study-assistant/blob/main/src/main/resources/static/sidebar.js"
click node_translations "https://github.com/ledat0105-na/study-assistant/blob/main/src/main/resources/static/i18n.js"
click node_citations "https://github.com/ledat0105-na/study-assistant/blob/main/src/main/resources/static/citations.js"
click node_session_fetch "https://github.com/ledat0105-na/study-assistant/blob/main/src/main/resources/static/auth-interceptor.js"
click node_application "https://github.com/ledat0105-na/study-assistant/blob/main/src/main/java/com/example/studyassistant/StudyAssistantApplication.java"
click node_auth "https://github.com/ledat0105-na/study-assistant/blob/main/src/main/java/com/example/studyassistant/controller/AuthController.java"
click node_user_service "https://github.com/ledat0105-na/study-assistant/blob/main/src/main/java/com/example/studyassistant/service/UserService.java"
click node_documents "https://github.com/ledat0105-na/study-assistant/blob/main/src/main/java/com/example/studyassistant/controller/DocumentController.java"
click node_document_service "https://github.com/ledat0105-na/study-assistant/blob/main/src/main/java/com/example/studyassistant/service/DocumentService.java"
click node_ai "https://github.com/ledat0105-na/study-assistant/blob/main/src/main/java/com/example/studyassistant/service/AiService.java"
click node_chat "https://github.com/ledat0105-na/study-assistant/blob/main/src/main/java/com/example/studyassistant/controller/ChatController.java"
click node_chat_service "https://github.com/ledat0105-na/study-assistant/blob/main/src/main/java/com/example/studyassistant/service/ChatService.java"
click node_study_tools "https://github.com/ledat0105-na/study-assistant/tree/main/src/main/java/com/example/studyassistant/controller"
click node_topics "https://github.com/ledat0105-na/study-assistant/blob/main/src/main/java/com/example/studyassistant/controller/TopicController.java"
click node_progress "https://github.com/ledat0105-na/study-assistant/blob/main/src/main/java/com/example/studyassistant/controller/ProgressController.java"
click node_subscriptions "https://github.com/ledat0105-na/study-assistant/blob/main/src/main/java/com/example/studyassistant/controller/PaymentController.java"
click node_quota "https://github.com/ledat0105-na/study-assistant/blob/main/src/main/java/com/example/studyassistant/service/QuotaService.java"
click node_admin_ops "https://github.com/ledat0105-na/study-assistant/blob/main/src/main/java/com/example/studyassistant/controller/AdminController.java"
click node_entities "https://github.com/ledat0105-na/study-assistant/tree/main/src/main/java/com/example/studyassistant/entity"
click node_repositories "https://github.com/ledat0105-na/study-assistant/tree/main/src/main/java/com/example/studyassistant/repository"
click node_uploads "https://github.com/ledat0105-na/study-assistant/tree/main/storage_private/uploads"

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_admin_ops toneAmber
class node_application,node_auth,node_user_service,node_documents,node_document_service,node_ai,node_chat,node_chat_service,node_study_tools,node_topics,node_progress,node_subscriptions,node_quota,node_ai_provider toneMint
class node_entities,node_repositories,node_database,node_uploads toneRose
class node_study_ui,node_sidebar,node_translations,node_citations,node_session_fetch,node_student,node_admin_actor toneIndigo
```

## Components

### Administration

- [Admin operations](https://github.com/ledat0105-na/study-assistant/blob/main/src/main/java/com/example/studyassistant/controller/AdminController.java): `src/main/java/com/example/studyassistant/controller/AdminController.java`

### Backend services

- [Spring application](https://github.com/ledat0105-na/study-assistant/blob/main/src/main/java/com/example/studyassistant/StudyAssistantApplication.java): `src/main/java/com/example/studyassistant/StudyAssistantApplication.java`
- [Authentication](https://github.com/ledat0105-na/study-assistant/blob/main/src/main/java/com/example/studyassistant/controller/AuthController.java): `src/main/java/com/example/studyassistant/controller/AuthController.java`
- [User service](https://github.com/ledat0105-na/study-assistant/blob/main/src/main/java/com/example/studyassistant/service/UserService.java): `src/main/java/com/example/studyassistant/service/UserService.java`
- [Document management](https://github.com/ledat0105-na/study-assistant/blob/main/src/main/java/com/example/studyassistant/controller/DocumentController.java): `src/main/java/com/example/studyassistant/controller/DocumentController.java`
- [Document analysis](https://github.com/ledat0105-na/study-assistant/blob/main/src/main/java/com/example/studyassistant/service/DocumentService.java): `src/main/java/com/example/studyassistant/service/DocumentService.java`
- [AI integration](https://github.com/ledat0105-na/study-assistant/blob/main/src/main/java/com/example/studyassistant/service/AiService.java): `src/main/java/com/example/studyassistant/service/AiService.java`
- [AI study chat](https://github.com/ledat0105-na/study-assistant/blob/main/src/main/java/com/example/studyassistant/controller/ChatController.java): `src/main/java/com/example/studyassistant/controller/ChatController.java`
- [Chat service](https://github.com/ledat0105-na/study-assistant/blob/main/src/main/java/com/example/studyassistant/service/ChatService.java): `src/main/java/com/example/studyassistant/service/ChatService.java`
- [Quiz and flashcards](https://github.com/ledat0105-na/study-assistant/tree/main/src/main/java/com/example/studyassistant/controller): `src/main/java/com/example/studyassistant/controller`
- [Knowledge topics](https://github.com/ledat0105-na/study-assistant/blob/main/src/main/java/com/example/studyassistant/controller/TopicController.java): `src/main/java/com/example/studyassistant/controller/TopicController.java`
- [Learning progress](https://github.com/ledat0105-na/study-assistant/blob/main/src/main/java/com/example/studyassistant/controller/ProgressController.java): `src/main/java/com/example/studyassistant/controller/ProgressController.java`
- [Plans and payments](https://github.com/ledat0105-na/study-assistant/blob/main/src/main/java/com/example/studyassistant/controller/PaymentController.java): `src/main/java/com/example/studyassistant/controller/PaymentController.java`
- [Usage quotas](https://github.com/ledat0105-na/study-assistant/blob/main/src/main/java/com/example/studyassistant/service/QuotaService.java): `src/main/java/com/example/studyassistant/service/QuotaService.java`
- **OpenAI / LLM**

### Persistent data

- [Domain entities](https://github.com/ledat0105-na/study-assistant/tree/main/src/main/java/com/example/studyassistant/entity): `src/main/java/com/example/studyassistant/entity`
- [Repositories](https://github.com/ledat0105-na/study-assistant/tree/main/src/main/java/com/example/studyassistant/repository): `src/main/java/com/example/studyassistant/repository`
- **MySQL database**
- [Private uploads](https://github.com/ledat0105-na/study-assistant/tree/main/storage_private/uploads): `storage_private/uploads`

### Web interface

- [Study pages](https://github.com/ledat0105-na/study-assistant/tree/main/src/main/resources/static): `src/main/resources/static`
- [Sidebar and logout](https://github.com/ledat0105-na/study-assistant/blob/main/src/main/resources/static/sidebar.js): `src/main/resources/static/sidebar.js`
- [UI translations](https://github.com/ledat0105-na/study-assistant/blob/main/src/main/resources/static/i18n.js): `src/main/resources/static/i18n.js`
- [Citation links](https://github.com/ledat0105-na/study-assistant/blob/main/src/main/resources/static/citations.js): `src/main/resources/static/citations.js`
- [Session fetch wrapper](https://github.com/ledat0105-na/study-assistant/blob/main/src/main/resources/static/auth-interceptor.js): `src/main/resources/static/auth-interceptor.js`

### Other components

- **Student**
- **Administrator**

## Connections

- Student → Study pages: uses (evidence: `README.md`)
- Administrator → Study pages: uses (evidence: `README.md`)
- Study pages → Authentication: authenticates
- Study pages → Document management: uploads documents
- Study pages → AI study chat: asks questions
- Study pages → Quiz and flashcards: studies with
- Study pages → Knowledge topics: views maps
- Study pages → Learning progress: views progress
- Study pages → Plans and payments: manages plans
- Study pages → Admin operations: administers
- Study pages → UI translations: localizes (evidence: `src/main/resources/static/i18n.js`)
- Study pages → Sidebar and logout: renders navigation
- Study pages → Citation links: renders citations
- Sidebar and logout → Authentication: posts logout (evidence: `src/main/resources/static/sidebar.js`)
- Study pages → Session fetch wrapper: wraps fetch
- Spring application → Authentication: serves routes
- Document management → Document analysis: delegates
- Document analysis → AI integration: analyzes with
- AI study chat → Chat service: delegates
- Chat service → AI integration: queries
- AI integration → OpenAI / LLM: calls model
- Document management → Private uploads: stores files
- User service → Repositories: accesses
- Document analysis → Repositories: accesses
- Chat service → Repositories: accesses
- Quiz and flashcards → Repositories: accesses
- Knowledge topics → Repositories: accesses
- Learning progress → Repositories: accesses
- Plans and payments → Repositories: accesses
- Admin operations → Repositories: accesses
- Usage quotas → Repositories: accesses
- Repositories → Domain entities: maps records
- Repositories → MySQL database: persists
- Plans and payments → Usage quotas: enforces limits
