How yadavnikhil17102004/secure-p2p-learning-platform works
Main Components
• Frontend: Represented by the “frontend” directory which houses the React application. Key elements include:
• UI Pages such as Dashboard, Login, Register, Profile, and LearningSession.
• Components (e.g., Navbar) and Contexts (e.g., AuthContext) for state management.
• Backend: Located in the “backend” directory with main parts including:
• API Entry Point: main.py that sets up the FastAPI application.
• Authentication & Authorization: Likely integrated in models.py and proper route handling (implied from the README mentioning JWT-based authentication and role-based access control).
• Database Access: database.py connecting to PostgreSQL.
• Encryption Services: encryption.py implementing end-to-end encryption using the Signal Protocol.
• Google Meet Integration: google_meet.py handling real-time video conferencing features.
• Database: PostgreSQL (as specified) which will be one of the key external components interacting with the backend.
• External Services:
• Google Meet API integration.
• Possibly WebRTC components for P2P communication.
Relationships and Interactions
• Backend interactions include:
• Authenticating users (JWT-based) and enforcing role-based access.
• Triggering encryption/decryption workflows when processing secure communications (via the encryption module).
• Interacting with the Google Meet API for initiating video conferences.
• Reading from and writing to PostgreSQL through database.py.
Architectural Patterns or Design Principles
• Separation of Concerns: Illustrate a clear separation between frontend and backend responsibilities.
• Security-Centric Design: Emphasize the encryption and authentication modules that enforce data security.
• Modular Architecture: Each file in the backend—cryptographic functions, database connections, third-party integrations—is a module/component.
• API Driven: The front end interacts with a RESTful (or possibly asynchronous) API provided by FastAPI.
Relevant Technologies, Frameworks, and Libraries
• Python FastAPI (Backend)
• React & TypeScript (Frontend)
• PostgreSQL (Database)
• Signal Protocol (for encryption)
• WebRTC (for real-time peer-to-peer communication)
• Google Meet API (for video conferencing)
• JWT for authentication