How ledat0105-na/study-assistant works
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: static Study pages · repository Repositories · DocumentController.java Document management · DocumentService.java Document analysis
Components 26
Administration
- Admin operations
src/main/java/com/example/studyassistant/controller/AdminController.java
Backend services
- Spring application
src/main/java/com/example/studyassistant/StudyAssistantApplication.java - Authentication
src/main/java/com/example/studyassistant/controller/AuthController.java - User service
src/main/java/com/example/studyassistant/service/UserService.java - Document management
src/main/java/com/example/studyassistant/controller/DocumentController.java - Document analysis
src/main/java/com/example/studyassistant/service/DocumentService.java - AI integration
src/main/java/com/example/studyassistant/service/AiService.java - AI study chat
src/main/java/com/example/studyassistant/controller/ChatController.java - Chat service
src/main/java/com/example/studyassistant/service/ChatService.java - Quiz and flashcards
src/main/java/com/example/studyassistant/controller - Knowledge topics
src/main/java/com/example/studyassistant/controller/TopicController.java - Learning progress
src/main/java/com/example/studyassistant/controller/ProgressController.java - Plans and payments
src/main/java/com/example/studyassistant/controller/PaymentController.java - Usage quotas
src/main/java/com/example/studyassistant/service/QuotaService.java - OpenAI / LLM
Persistent data
- Domain entities
src/main/java/com/example/studyassistant/entity - Repositories
src/main/java/com/example/studyassistant/repository - MySQL database
- Private uploads
storage_private/uploads
Web interface
- Study pages
src/main/resources/static - Sidebar and logout
src/main/resources/static/sidebar.js - UI translations
src/main/resources/static/i18n.js - Citation links
src/main/resources/static/citations.js - Session fetch wrapper
src/main/resources/static/auth-interceptor.js
Other components
- Student
- Administrator
Connections 34
- Student → Study pages: uses
README.md - Administrator → Study pages: uses
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
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
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