How abhinav-vishwakarma/studyaid-ai works
Main System Components
a) Client Layer:
• React.js Frontend (Single Page Application)
• User Interface Components (Home, Notes, PYQs, Predicted, etc.)
b) API Layer:
• Express.js Backend Server
• RESTful API Endpoints
• File Upload/Download Controllers
c) Service Layer:
• AI Services (Google Generative AI/Gemini)
• File Storage Service
• Database Service
d) Storage Layer:
• MySQL Database
• File Storage System (for PDFs and documents)
Component Relationships
a) Data Flow:
• User requests → Frontend → Backend API → Services → Storage
• File uploads path
• AI processing flow
• Search and retrieval paths
b) Integration Points:
• Frontend-Backend communication via REST APIs
• Backend-AI service integration
• Database connections
• File storage interactions
Detailed Component Breakdown
Frontend Components:
• Public Assets
• React Components
• Core Components
• Pages
• Context Providers
• Styles
Backend Components:
• Controllers
• File Controllers
• Routes
• File Routes
• Services
• AI Service
• File Service
• Database Service
• Storage
• Uploads
Key Interactions to Highlight
a) File Management Flow:
• Upload → Processing → Storage → Indexing
• Retrieval → Serving
b) AI Processing Flow:
• Document Analysis
• Topic Extraction
• Question Prediction
• Summary Generation
c) Search Operations:
• User Query → Search Index → Results
• AI-Enhanced Search Process