How codefarm0/ai-powered-text-summariser works
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: SummaryService.java Summary workflow · ConversationService.java Conversation workflow · controller REST controllers · AiService.java Model orchestration
Components 22
React client
- Application shell
frontend-react/src/App.tsx - Guest user context
frontend-react/src/context/UserContext.tsx - Project dashboard
frontend-react/src/pages/Dashboard.tsx - Project workspace
frontend-react/src/pages/ProjectWorkspace.tsx - API clients
frontend-react/src/services/api.ts - Summary interface
frontend-react/src/components/SummaryEditor.tsx - Chat interface
frontend-react/src/components/ChatPanel.tsx - Document upload
frontend-react/src/components/DocumentUpload.tsx
Spring API
- REST controllers
ai-text-summariser/src/main/java/in/codefarm/ai/text/summariser/controller
Project work
- Summary workflow
ai-text-summariser/src/main/java/in/codefarm/ai/text/summariser/service/SummaryService.java - Conversation workflow
ai-text-summariser/src/main/java/in/codefarm/ai/text/summariser/service/ConversationService.java - Project management
ai-text-summariser/src/main/java/in/codefarm/ai/text/summariser/service/ProjectService.java - Document processing
ai-text-summariser/src/main/java/in/codefarm/ai/text/summariser/service/DocumentService.java - Local file storage
ai-text-summariser/src/main/java/in/codefarm/ai/text/summariser/service/FileStorageService.java
AI services
- Model orchestration
ai-text-summariser/src/main/java/in/codefarm/ai/text/summariser/service/AiService.java - Summary prompts
ai-text-summariser/src/main/java/in/codefarm/ai/text/summariser/ai/prompt/SummaryPrompts.java
Persistence
- Entity mapping
ai-text-summariser/src/main/java/in/codefarm/ai/text/summariser/mapper/EntityMapper.java - Data repositories
ai-text-summariser/src/main/java/in/codefarm/ai/text/summariser/repository - Domain records
ai-text-summariser/src/main/java/in/codefarm/ai/text/summariser/entity
Other components
- User
- Ollama models
- MySQL
Connections 25
- User → Application shell: uses
- Application shell → Guest user context: provides context
frontend-react/src/App.tsx - Guest user context → API clients: creates guest
frontend-react/src/context/UserContext.tsx - Project dashboard → API clients: requests projects
- Project workspace → API clients: uses API
- Summary interface → Project workspace: supports summaries
frontend-react/src/pages/ProjectWorkspace.tsx - Chat interface → Project workspace: supports chat
frontend-react/src/pages/ProjectWorkspace.tsx - Document upload → Project workspace: supports uploads
frontend-react/src/pages/ProjectWorkspace.tsx - Application shell → REST controllers: REST requests
- API clients → REST controllers: calls API
- REST controllers → Summary workflow: delegates summaries
ai-text-summariser/src/main/java/in/codefarm/ai/text/summariser/controller/SummaryController.java - REST controllers → Conversation workflow: delegates conversations
ai-text-summariser/src/main/java/in/codefarm/ai/text/summariser/controller/ConversationController.java - Summary workflow → Project management: checks project
ai-text-summariser/src/main/java/in/codefarm/ai/text/summariser/service/SummaryService.java - Summary workflow → Model orchestration: requests summary
ai-text-summariser/src/main/java/in/codefarm/ai/text/summariser/service/SummaryService.java - Conversation workflow → Model orchestration: requests chat
ai-text-summariser/src/main/java/in/codefarm/ai/text/summariser/service/ConversationService.java - Model orchestration → Summary prompts: builds prompt
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
ai-text-summariser/src/main/java/in/codefarm/ai/text/summariser/service/DocumentService.java - Summary workflow → Data repositories: saves summaries
ai-text-summariser/src/main/java/in/codefarm/ai/text/summariser/service/SummaryService.java - Conversation workflow → Data repositories: reads and saves messages
ai-text-summariser/src/main/java/in/codefarm/ai/text/summariser/service/ConversationService.java - Project management → Data repositories: manages projects
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
ai-text-summariser/src/main/java/in/codefarm/ai/text/summariser/service/SummaryService.java - Conversation workflow → Entity mapping: maps responses
ai-text-summariser/src/main/java/in/codefarm/ai/text/summariser/service/ConversationService.java