How rks-031/pragati works
Main Components
• Frontend:
• Built with Vite and ReactJS, it is responsible for rendering the UI, managing user flows (login, registration, assessment, exam upload, etc.), and handling offline capabilities.
• Key files/folders include: frontend/src (with components, context, pages, and styles) and configuration files like vite.config.js.
• Backend:
• Developed in Python using FastAPI, responsible for handling business logic, authentication, data management, and serving RESTful endpoints.
• Look at the backend folder structure, including directories for config, routes (assessment, auth, course routes), services (db_services, gcs_service, scheduler_services, sms_service), and utilities.
• Database & Data Models:
• Within the backend/db folder, models.py implies ORM or database schema definitions.
• External/Cloud Services:
• As described in the README, several Google Cloud services are used (Cloud Storage, Firestore, Firebase, text-to-speech, speech-to-text, IoT Core, Google Maps API, Cloud Run) along with the Twilio API.
• Offline & Mesh Networking Capabilities:
• The platform’s offline-first design and peer-to-peer sharing indicate that there’s a mechanism for local caching of educational content and synchronization when connectivity is available.
• Deployment Components:
Relationships and Data Flow
• Backend Interactions:
• Internal routing: Show a high-level interconnection between the different backend components (routes, services, and database).
• Services: Particularly note interactions like SMS services (using Twilio), GCS services (for storing/downloading course materials), scheduler services (for timed operations), and any database interactions through db_services.
• External Cloud Integrations:
• Offline & Peer-to-Peer Mesh:
• Offline content download module and possibly a peer-to-peer sharing component that supports local mesh networking and content synchronization.
Architectural Patterns & Design Principles
• Modular Separation:
• Clearly distinguish between the frontend (client-side logic/UI) and backend (API endpoints, business logic).
• Separation of concerns, with individual modules for configuration, routing, logging, and services.
• Scalability & Extensibility:
• The project’s architecture hints at microservices-like separation within the backend, modular enough to allow for future expansion and integration.
• Offline-First Strategy:
• Aspects that enable the system to work offline and synchronize data once connectivity is available.
Relevant Technologies & Frameworks
• Frontend: ReactJS, Vite, Axios (as seen in axiosConfig.jsx), CSS modules and custom styles.
• Backend: Python (FastAPI framework), YAML configuration, RESTful routes.
• Cloud Technologies: GCP (with services like Cloud Storage, Firestore, Firebase), Twilio for SMS, and potentially integrations with text-to-speech and speech-to-text services.
• Deployment: Google App Engine (backend), Vercel (frontend).