How shreyas5080/studyflow works
StudyFlow is a React/FastAPI study-planning application. Students register or sign in, then manage subjects and view a study timetable; the backend provides authentication, subject/topic APIs, and AI table generation. The README also describes progress, plans, resources, and related data entities, though their full UI and runtime wiring are not shown in the excerpts. Dashed links mark documented or plausible integrations whose implementation relationship was not directly excerpted.
Main entry points: App.jsx Page routing · app.py FastAPI application · deps.py Auth and DB dependencies · api.js Authenticated requests
Components 25
Student experience
- Browser UI
- Page routing
FrontEnd/src/App.jsx - Home page
FrontEnd/src/pages/Home.jsx - Registration page
FrontEnd/src/pages/Register.jsx - Login page
FrontEnd/src/pages/Login.jsx - Student dashboard
FrontEnd/src/pages/dashboard/Student.jsx - Subject management
FrontEnd/src/pages/dashboard/Subject.jsx - Subject editor
FrontEnd/src/pages/dashboard/EditSubject.jsx - Timetable page
FrontEnd/src/pages/dashboard/TimeTable.jsx - Authenticated requests
FrontEnd/src/api.js
Backend services
- FastAPI application
backend/app.py - Auth and DB dependencies
backend/src/deps.py
Identity and verification
- Login endpoints
backend/src/routes/login.py - OTP verification
backend/src/auth/otp.py - OTP email sender
backend/src/email_service.py - Redis OTP store
Study planning
- Subject endpoints
backend/src/routes/subjects.py - Topic endpoints
backend/src/routes/topics.py - AI table generation
backend/src/AI/generate_tableAI.py
Persistence
- Study data models
backend/src/models.py - SQLAlchemy setup
backend/src/database.py - PostgreSQL
Other components
- Student
- Email provider
- NVIDIA API
Connections 35
- Student → Browser UI: uses
README.md - Browser UI → Page routing: opens pages
README.md - Page routing → Home page: routes to
FrontEnd/src/App.jsx - Page routing → Registration page: routes to
FrontEnd/src/App.jsx - Page routing → Login page: routes to
FrontEnd/src/App.jsx - Page routing → Student dashboard: routes to
FrontEnd/src/App.jsx - Page routing → Subject management: routes to
FrontEnd/src/App.jsx - Page routing → Subject editor: routes to
FrontEnd/src/App.jsx - Page routing → Timetable page: routes to
FrontEnd/src/App.jsx - Subject management → Authenticated requests: sends requests
FrontEnd/src/pages/dashboard/Subject.jsx - Subject editor → Authenticated requests: sends requests
FrontEnd/src/pages/dashboard/EditSubject.jsx - Student dashboard → Authenticated requests: sends requests
FrontEnd/src/pages/dashboard/Student.jsx - Timetable page → Authenticated requests: sends requests
FrontEnd/src/pages/dashboard/TimeTable.jsx - Subject management → Subject endpoints: calls subject API
FrontEnd/src/pages/dashboard/Subject.jsx - FastAPI application → Login endpoints: registers router
backend/app.py - FastAPI application → Subject endpoints: registers router
backend/app.py - FastAPI application → Topic endpoints: registers router
backend/app.py - FastAPI application → AI table generation: registers router
backend/app.py - FastAPI application → OTP verification: calls OTP functions
backend/app.py - FastAPI application → OTP email sender: sends OTP email
backend/app.py - FastAPI application → Auth and DB dependencies: uses DB dependency
backend/app.py - Login endpoints → Auth and DB dependencies: uses dependencies
backend/src/routes/login.py - Subject endpoints → Auth and DB dependencies: uses dependencies
backend/src/routes/subjects.py - Topic endpoints → Auth and DB dependencies: uses dependencies
backend/src/routes/topics.py - OTP verification → Redis OTP store: stores OTPs
backend/src/auth/otp.py - OTP email sender → Email provider: sends email
backend/src/email_service.py - Auth and DB dependencies → SQLAlchemy setup: creates sessions
backend/src/deps.py - SQLAlchemy setup → Study data models: provides model base
backend/src/models.py - Study data models → PostgreSQL: maps study data
README.md - AI table generation → Study data models: uses models
backend/src/AI/generate_tableAI.py - AI table generation → Auth and DB dependencies: uses dependencies
backend/src/AI/generate_tableAI.py - AI table generation → NVIDIA API: uses AI service
README.md - Authenticated requests → FastAPI application: calls API
README.md - Registration page → OTP verification: requests verification
README.md - Student dashboard → Study data models: tracks progress
README.md