# codefarm0/ai-powered-text-summariser architecture

> Architecture diagram of the GitHub repository codefarm0/ai-powered-text-summariser, 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/codefarm0/ai-powered-text-summariser
- Repository: https://github.com/codefarm0/ai-powered-text-summariser

## Overview

This is a project-centered AI text summarizer: users organize work into projects, add documents or text, generate and revisit summaries, and continue with AI conversations. The React client uses a Spring Boot API; backend services orchestrate prompts, local-model requests, persistence, and document storage. The README documents additional capabilities such as multiple summary types, model selection, and history. Some controllers and services are unsampled, so their internal links are shown only where the README or excerpts support them.

Main entry points: [`ai-text-summariser/src/main/java/in/codefarm/ai/text/summariser/service/SummaryService.java`](https://github.com/codefarm0/ai-powered-text-summariser/blob/main/ai-text-summariser/src/main/java/in/codefarm/ai/text/summariser/service/SummaryService.java) (Summary workflow), [`ai-text-summariser/src/main/java/in/codefarm/ai/text/summariser/service/ConversationService.java`](https://github.com/codefarm0/ai-powered-text-summariser/blob/main/ai-text-summariser/src/main/java/in/codefarm/ai/text/summariser/service/ConversationService.java) (Conversation workflow), [`ai-text-summariser/src/main/java/in/codefarm/ai/text/summariser/controller`](https://github.com/codefarm0/ai-powered-text-summariser/tree/main/ai-text-summariser/src/main/java/in/codefarm/ai/text/summariser/controller) (REST controllers), [`ai-text-summariser/src/main/java/in/codefarm/ai/text/summariser/service/AiService.java`](https://github.com/codefarm0/ai-powered-text-summariser/blob/main/ai-text-summariser/src/main/java/in/codefarm/ai/text/summariser/service/AiService.java) (Model orchestration)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_client["React client"]
  node_react["Application shell<br/>[App.tsx]"]
  node_userctx["Guest user context<br/>[UserContext.tsx]"]
  node_dashboard["Project dashboard<br/>[Dashboard.tsx]"]
  node_workspace["Project workspace"]
  node_uiservices["API clients<br/>[api.ts]"]
  node_summaryui["Summary interface<br/>[SummaryEditor.tsx]"]
  node_chatui["Chat interface<br/>[ChatPanel.tsx]"]
  node_uploadui["Document upload<br/>[DocumentUpload.tsx]"]
end

subgraph group_api["Spring API"]
  node_controllers["REST controllers"]
end

subgraph group_work["Project work"]
  node_summarysvc["Summary workflow"]
  node_chatsvc["Conversation workflow"]
  node_projects["Project management"]
  node_documents["Document processing"]
  node_files["Local file storage"]
end

subgraph group_ai["AI services"]
  node_ai["Model orchestration<br/>[AiService.java]"]
  node_prompts["Summary prompts"]
end

subgraph group_storage["Persistence"]
  node_mapper["Entity mapping<br/>[EntityMapper.java]"]
  node_repositories["Data repositories"]
  node_entities["Domain records"]
end

node_user(("User"))
node_ollama["Ollama models"]
node_database[("MySQL")]

node_user -->|"uses"| node_react
node_react -->|"provides context"| node_userctx
node_userctx -->|"creates guest"| node_uiservices
node_dashboard -.->|"requests projects"| node_uiservices
node_workspace -.->|"uses API"| node_uiservices
node_summaryui -.->|"supports summaries"| node_workspace
node_chatui -.->|"supports chat"| node_workspace
node_uploadui -.->|"supports uploads"| node_workspace
node_react -->|"REST requests"| node_controllers
node_uiservices -->|"calls API"| node_controllers
node_controllers -->|"delegates summaries"| node_summarysvc
node_controllers -->|"delegates conversations"| node_chatsvc
node_summarysvc -->|"checks project"| node_projects
node_summarysvc -->|"requests summary"| node_ai
node_chatsvc -->|"requests chat"| node_ai
node_ai -->|"builds prompt"| node_prompts
node_ai -->|"generates responses"| node_ollama
node_documents -.->|"stores uploads"| node_files
node_summarysvc -->|"saves summaries"| node_repositories
node_chatsvc -->|"reads and saves messages"| node_repositories
node_projects -->|"manages projects"| node_repositories
node_repositories -->|"persists records"| node_database
node_entities -->|"mapped records"| node_database
node_summarysvc -->|"maps responses"| node_mapper
node_chatsvc -->|"maps responses"| node_mapper

click node_react "https://github.com/codefarm0/ai-powered-text-summariser/blob/main/frontend-react/src/App.tsx"
click node_userctx "https://github.com/codefarm0/ai-powered-text-summariser/blob/main/frontend-react/src/context/UserContext.tsx"
click node_dashboard "https://github.com/codefarm0/ai-powered-text-summariser/blob/main/frontend-react/src/pages/Dashboard.tsx"
click node_workspace "https://github.com/codefarm0/ai-powered-text-summariser/blob/main/frontend-react/src/pages/ProjectWorkspace.tsx"
click node_uiservices "https://github.com/codefarm0/ai-powered-text-summariser/blob/main/frontend-react/src/services/api.ts"
click node_summaryui "https://github.com/codefarm0/ai-powered-text-summariser/blob/main/frontend-react/src/components/SummaryEditor.tsx"
click node_chatui "https://github.com/codefarm0/ai-powered-text-summariser/blob/main/frontend-react/src/components/ChatPanel.tsx"
click node_uploadui "https://github.com/codefarm0/ai-powered-text-summariser/blob/main/frontend-react/src/components/DocumentUpload.tsx"
click node_controllers "https://github.com/codefarm0/ai-powered-text-summariser/tree/main/ai-text-summariser/src/main/java/in/codefarm/ai/text/summariser/controller"
click node_summarysvc "https://github.com/codefarm0/ai-powered-text-summariser/blob/main/ai-text-summariser/src/main/java/in/codefarm/ai/text/summariser/service/SummaryService.java"
click node_chatsvc "https://github.com/codefarm0/ai-powered-text-summariser/blob/main/ai-text-summariser/src/main/java/in/codefarm/ai/text/summariser/service/ConversationService.java"
click node_projects "https://github.com/codefarm0/ai-powered-text-summariser/blob/main/ai-text-summariser/src/main/java/in/codefarm/ai/text/summariser/service/ProjectService.java"
click node_documents "https://github.com/codefarm0/ai-powered-text-summariser/blob/main/ai-text-summariser/src/main/java/in/codefarm/ai/text/summariser/service/DocumentService.java"
click node_files "https://github.com/codefarm0/ai-powered-text-summariser/blob/main/ai-text-summariser/src/main/java/in/codefarm/ai/text/summariser/service/FileStorageService.java"
click node_ai "https://github.com/codefarm0/ai-powered-text-summariser/blob/main/ai-text-summariser/src/main/java/in/codefarm/ai/text/summariser/service/AiService.java"
click node_prompts "https://github.com/codefarm0/ai-powered-text-summariser/blob/main/ai-text-summariser/src/main/java/in/codefarm/ai/text/summariser/ai/prompt/SummaryPrompts.java"
click node_mapper "https://github.com/codefarm0/ai-powered-text-summariser/blob/main/ai-text-summariser/src/main/java/in/codefarm/ai/text/summariser/mapper/EntityMapper.java"
click node_repositories "https://github.com/codefarm0/ai-powered-text-summariser/tree/main/ai-text-summariser/src/main/java/in/codefarm/ai/text/summariser/repository"
click node_entities "https://github.com/codefarm0/ai-powered-text-summariser/tree/main/ai-text-summariser/src/main/java/in/codefarm/ai/text/summariser/entity"

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_react,node_userctx,node_dashboard,node_workspace,node_uiservices,node_summaryui,node_chatui,node_uploadui,node_user toneBlue
class node_controllers,node_database toneAmber
class node_summarysvc,node_chatsvc,node_projects,node_documents,node_files toneMint
class node_ai,node_prompts toneRose
class node_mapper,node_repositories,node_entities,node_ollama toneIndigo
```

## Components

### React client

- [Application shell](https://github.com/codefarm0/ai-powered-text-summariser/blob/main/frontend-react/src/App.tsx): `frontend-react/src/App.tsx`
- [Guest user context](https://github.com/codefarm0/ai-powered-text-summariser/blob/main/frontend-react/src/context/UserContext.tsx): `frontend-react/src/context/UserContext.tsx`
- [Project dashboard](https://github.com/codefarm0/ai-powered-text-summariser/blob/main/frontend-react/src/pages/Dashboard.tsx): `frontend-react/src/pages/Dashboard.tsx`
- [Project workspace](https://github.com/codefarm0/ai-powered-text-summariser/blob/main/frontend-react/src/pages/ProjectWorkspace.tsx): `frontend-react/src/pages/ProjectWorkspace.tsx`
- [API clients](https://github.com/codefarm0/ai-powered-text-summariser/blob/main/frontend-react/src/services/api.ts): `frontend-react/src/services/api.ts`
- [Summary interface](https://github.com/codefarm0/ai-powered-text-summariser/blob/main/frontend-react/src/components/SummaryEditor.tsx): `frontend-react/src/components/SummaryEditor.tsx`
- [Chat interface](https://github.com/codefarm0/ai-powered-text-summariser/blob/main/frontend-react/src/components/ChatPanel.tsx): `frontend-react/src/components/ChatPanel.tsx`
- [Document upload](https://github.com/codefarm0/ai-powered-text-summariser/blob/main/frontend-react/src/components/DocumentUpload.tsx): `frontend-react/src/components/DocumentUpload.tsx`

### Spring API

- [REST controllers](https://github.com/codefarm0/ai-powered-text-summariser/tree/main/ai-text-summariser/src/main/java/in/codefarm/ai/text/summariser/controller): `ai-text-summariser/src/main/java/in/codefarm/ai/text/summariser/controller`

### Project work

- [Summary workflow](https://github.com/codefarm0/ai-powered-text-summariser/blob/main/ai-text-summariser/src/main/java/in/codefarm/ai/text/summariser/service/SummaryService.java): `ai-text-summariser/src/main/java/in/codefarm/ai/text/summariser/service/SummaryService.java`
- [Conversation workflow](https://github.com/codefarm0/ai-powered-text-summariser/blob/main/ai-text-summariser/src/main/java/in/codefarm/ai/text/summariser/service/ConversationService.java): `ai-text-summariser/src/main/java/in/codefarm/ai/text/summariser/service/ConversationService.java`
- [Project management](https://github.com/codefarm0/ai-powered-text-summariser/blob/main/ai-text-summariser/src/main/java/in/codefarm/ai/text/summariser/service/ProjectService.java): `ai-text-summariser/src/main/java/in/codefarm/ai/text/summariser/service/ProjectService.java`
- [Document processing](https://github.com/codefarm0/ai-powered-text-summariser/blob/main/ai-text-summariser/src/main/java/in/codefarm/ai/text/summariser/service/DocumentService.java): `ai-text-summariser/src/main/java/in/codefarm/ai/text/summariser/service/DocumentService.java`
- [Local file storage](https://github.com/codefarm0/ai-powered-text-summariser/blob/main/ai-text-summariser/src/main/java/in/codefarm/ai/text/summariser/service/FileStorageService.java): `ai-text-summariser/src/main/java/in/codefarm/ai/text/summariser/service/FileStorageService.java`

### AI services

- [Model orchestration](https://github.com/codefarm0/ai-powered-text-summariser/blob/main/ai-text-summariser/src/main/java/in/codefarm/ai/text/summariser/service/AiService.java): `ai-text-summariser/src/main/java/in/codefarm/ai/text/summariser/service/AiService.java`
- [Summary prompts](https://github.com/codefarm0/ai-powered-text-summariser/blob/main/ai-text-summariser/src/main/java/in/codefarm/ai/text/summariser/ai/prompt/SummaryPrompts.java): `ai-text-summariser/src/main/java/in/codefarm/ai/text/summariser/ai/prompt/SummaryPrompts.java`

### Persistence

- [Entity mapping](https://github.com/codefarm0/ai-powered-text-summariser/blob/main/ai-text-summariser/src/main/java/in/codefarm/ai/text/summariser/mapper/EntityMapper.java): `ai-text-summariser/src/main/java/in/codefarm/ai/text/summariser/mapper/EntityMapper.java`
- [Data repositories](https://github.com/codefarm0/ai-powered-text-summariser/tree/main/ai-text-summariser/src/main/java/in/codefarm/ai/text/summariser/repository): `ai-text-summariser/src/main/java/in/codefarm/ai/text/summariser/repository`
- [Domain records](https://github.com/codefarm0/ai-powered-text-summariser/tree/main/ai-text-summariser/src/main/java/in/codefarm/ai/text/summariser/entity): `ai-text-summariser/src/main/java/in/codefarm/ai/text/summariser/entity`

### Other components

- **User**
- **Ollama models**
- **MySQL**

## Connections

- User → Application shell: uses
- Application shell → Guest user context: provides context (evidence: `frontend-react/src/App.tsx`)
- Guest user context → API clients: creates guest (evidence: `frontend-react/src/context/UserContext.tsx`)
- Project dashboard → API clients: requests projects
- Project workspace → API clients: uses API
- Summary interface → Project workspace: supports summaries (evidence: `frontend-react/src/pages/ProjectWorkspace.tsx`)
- Chat interface → Project workspace: supports chat (evidence: `frontend-react/src/pages/ProjectWorkspace.tsx`)
- Document upload → Project workspace: supports uploads (evidence: `frontend-react/src/pages/ProjectWorkspace.tsx`)
- Application shell → REST controllers: REST requests
- API clients → REST controllers: calls API
- REST controllers → Summary workflow: delegates summaries (evidence: `ai-text-summariser/src/main/java/in/codefarm/ai/text/summariser/controller/SummaryController.java`)
- REST controllers → Conversation workflow: delegates conversations (evidence: `ai-text-summariser/src/main/java/in/codefarm/ai/text/summariser/controller/ConversationController.java`)
- Summary workflow → Project management: checks project (evidence: `ai-text-summariser/src/main/java/in/codefarm/ai/text/summariser/service/SummaryService.java`)
- Summary workflow → Model orchestration: requests summary (evidence: `ai-text-summariser/src/main/java/in/codefarm/ai/text/summariser/service/SummaryService.java`)
- Conversation workflow → Model orchestration: requests chat (evidence: `ai-text-summariser/src/main/java/in/codefarm/ai/text/summariser/service/ConversationService.java`)
- Model orchestration → Summary prompts: builds prompt (evidence: `ai-text-summariser/src/main/java/in/codefarm/ai/text/summariser/service/AiService.java`)
- Model orchestration → Ollama models: generates responses
- Document processing → Local file storage: stores uploads (evidence: `ai-text-summariser/src/main/java/in/codefarm/ai/text/summariser/service/DocumentService.java`)
- Summary workflow → Data repositories: saves summaries (evidence: `ai-text-summariser/src/main/java/in/codefarm/ai/text/summariser/service/SummaryService.java`)
- Conversation workflow → Data repositories: reads and saves messages (evidence: `ai-text-summariser/src/main/java/in/codefarm/ai/text/summariser/service/ConversationService.java`)
- Project management → Data repositories: manages projects (evidence: `ai-text-summariser/src/main/java/in/codefarm/ai/text/summariser/service/ProjectService.java`)
- Data repositories → MySQL: persists records
- Domain records → MySQL: mapped records
- Summary workflow → Entity mapping: maps responses (evidence: `ai-text-summariser/src/main/java/in/codefarm/ai/text/summariser/service/SummaryService.java`)
- Conversation workflow → Entity mapping: maps responses (evidence: `ai-text-summariser/src/main/java/in/codefarm/ai/text/summariser/service/ConversationService.java`)
