How chimple/cuba works
Key Components to Include in the System Design:
Frontend Architecture
• React Web Application
• Pages (src/pages)
• Components (src/components)
• Services (src/services)
• Models (src/models)
• Mobile Application (Android)
• Capacitor integration for mobile capabilities
• Native Android components (MainActivity, OTPReceiver, PortPlugin)
Backend Services
• Firebase Integration
• Authentication (FirebaseAuth)
• Remote Config
• API Services
• OneRoster API Integration
• Authentication
• Data Services
Data Flow Layers
• Service Layer
• API Handlers
• Authentication Handlers
• Service Configuration
• Model Layer
• Curriculum
• User Management
• Assignment System
• Live Quiz System
External Integrations
• Analytics Dashboard
• Looker Studio Integration
• School Management System
Use a layered architecture approach
• [Client Layer]
• Web App (React) ←→ Mobile App (Android/Capacitor)
• ↕ ↕
• [Service Layer]
• Firebase Services ←→ OneRoster Services
• ↕ ↕
• [Data Layer]
• Models & Controllers
• ↕
• [External Systems]
• Analytics & Reporting
Component Relationships
Special Considerations:
Multi-language Support
• I18n integration with supported languages (en, hi, kn, mr)
• Localization flow
Educational Features
• Curriculum management
• Quiz system architecture
• Assignment workflow
• Leaderboard system
User Management
• Teacher/Student/Parent roles
• School management
• Class management
• Profile management
Mobile-Specific Features
• Native capabilities
• OTP handling
• File system access
• Platform-specific optimizations
• Component types
• Connection types
• State management flow
• Data flow direction
Remember to include version control and CI/CD workflow indicators, as evidenced by the GitHub workflows in the repository.
This system design should provide a clear understanding of the application's architecture while maintaining the right balance between detail and abstraction.