How ravishankar141/study_buddy works
Study Buddy is a local AI study assistant: students upload material, then use it for notes, doubt solving, quizzes and revision planning. The React app routes users to feature pages; its API client sends requests to FastAPI, whose feature routes perform processing and persist selected results in SQLite. Authentication and password recovery form a separate capability. The README documents OCR/PDF extraction and performance analysis; sampled source confirms quiz analysis and upload utility wiring. Some unsampled feature internals and model-call relationships are therefore represented only where the README or source index supports them.
Main entry points: App.jsx App routing · main.py FastAPI app · api.js API client · db.py SQLite access
Components 22
Student application
- App routing
frontend/src/App.jsx - Auth state
frontend/src/AuthContext.jsx - API client
frontend/src/api.js - Upload page
frontend/src/pages/UploadPage.jsx - Notes page
frontend/src/pages/NotesPage.jsx - Doubt page
frontend/src/pages/DoubtPage.jsx - Quiz page
frontend/src/pages/QuizPage.jsx - Revision page
frontend/src/pages/RevisionPage.jsx
Backend API
- FastAPI app
backend/main.py
Learning features
- Document extraction
backend/routes/upload.py - PDF extraction
backend/utils/pdf.py - Image OCR
backend/utils/ocr.py - Smart notes
backend/routes/notes.py - Text chunking
backend/utils/chunking.py - Doubt solving
backend/routes/doubt.py - Quiz and analysis
backend/routes/quiz.py - Revision planning
backend/routes/revision.py
Identity
- Authentication
backend/routes/auth_routes.py - Token security
backend/utils/auth.py
Persistence
- SQLite access
backend/database/db.py - Domain records
backend/database/models.py
Other components
- Student
Connections 33
- Student → App routing: uses
README.md - App routing → Auth state: reads auth
frontend/src/App.jsx - App routing → Upload page: routes to
frontend/src/App.jsx - App routing → Notes page: routes to
frontend/src/App.jsx - App routing → Doubt page: routes to
frontend/src/App.jsx - App routing → Quiz page: routes to
frontend/src/App.jsx - App routing → Revision page: routes to
frontend/src/App.jsx - Auth state → API client: calls
frontend/src/AuthContext.jsx - Upload page → API client: uploads through
frontend/src/pages/UploadPage.jsx - Notes page → API client: requests notes
frontend/src/pages/NotesPage.jsx - Doubt page → API client: requests answers
frontend/src/pages/DoubtPage.jsx - Quiz page → API client: requests quiz
frontend/src/pages/QuizPage.jsx - Revision page → API client: requests plans
frontend/src/pages/RevisionPage.jsx - API client → FastAPI app: HTTP requests
frontend/src/api.js - FastAPI app → Document extraction: registers route
backend/main.py - FastAPI app → Smart notes: registers route
backend/main.py - FastAPI app → Doubt solving: registers route
backend/main.py - FastAPI app → Quiz and analysis: registers route
backend/main.py - FastAPI app → Revision planning: registers route
backend/main.py - FastAPI app → Authentication: registers route
backend/main.py - Document extraction → PDF extraction: uses
backend/routes/upload.py - Document extraction → Image OCR: uses
backend/routes/upload.py - Smart notes → Text chunking: chunks text
backend/routes/notes.py - Authentication → Token security: uses security
backend/routes/auth_routes.py - Authentication → SQLite access: queries
backend/routes/auth_routes.py - Authentication → Domain records: uses records
backend/routes/auth_routes.py - Smart notes → SQLite access: persists data
backend/routes/notes.py - Smart notes → Domain records: uses records
backend/routes/notes.py - Doubt solving → SQLite access: persists data
backend/routes/doubt.py - Doubt solving → Domain records: uses records
backend/routes/doubt.py - Quiz and analysis → SQLite access: persists quiz
backend/routes/quiz.py - Quiz and analysis → Domain records: uses records
backend/routes/quiz.py - Revision planning → SQLite access: stores plans
backend/routes/revision.py