How helpwave-app/helpwave_mobile_app works
Project type and purpose
• Project type: Full-stack mobile application (Android + iOS)
• Purpose: Connect users requesting help (especially seniors) with remote volunteers via video calls
File structure
Top-level directories:
• android/, ios/ → native platform shells (Gradle/Xcode projects, platform integration)
• lib/ → Flutter app code, organized in:
– localization (codegen, JSON files)
– src/common (themes, constants, animations, utilities, Firebase options)
– src/features (feature-based modules with application, domain, data, presentation layers)
– routing (AppRouter)
• scripts/ → CI/CD helpers (version bump, deploy)
• test/ → widget tests
Extract key insights from the README
• Frontend: Flutter 3.x + Riverpod/StateNotifier
• Backend: Spring Boot (Java) + PostgreSQL
• Communication & data: Firebase Auth, Firestore, Cloud Messaging
• Video: Agora Video SDK
• CI/CD: GitHub Actions, Firebase App Distribution
Main components
A. Mobile Client (Flutter)
1. Platform layers: Android shell, iOS shell
2. Flutter engine & Dart code
3. State management: Riverpod + StateNotifier
4. Feature modules (Auth, Availability, Gamification, Home, Language, Notifications, Profile, Reports, Reviews, Settings, Skills, Videocalls)
5. Routing layer (AppRouter)
6. Localization loader
B. External Services
1. Firebase Auth (user sign-in/up)
2. Firestore (real-time data store)
3. Firebase Cloud Messaging (push notifications)
4. Agora Video SDK (video-call sessions)
C. Backend API
1. Spring Boot REST service
2. PostgreSQL database
D. CI/CD
1. GitHub Actions workflows (build, version bump, release)
2. Firebase App Distribution
Relationships and data flows
• Mobile ↔ Firebase Auth: obtain JWT
• Mobile ↔ Spring Boot API: authenticated REST calls (help requests, profile, reports, gamification)
• Mobile ↔ Firestore: real-time updates (e.g., volunteer availability)
• Mobile ↔ FCM: subscribe & receive push notifications (new help request)
• Mobile ↔ Agora SDK: establish P2P video stream for calls
• Spring Boot → PostgreSQL: persistent storage of domain data
• CI/CD → GitHub → Build artifacts → Firebase App Distribution
Architectural patterns & design principles
• Feature-based modular structure (Clean Architecture flavor)
– Presentation (widgets/pages)
– Application (controllers/state notifiers)
– Domain (pure models/entities)
– Data (services, API clients, JSON models)
• Separation of concerns: UI vs state vs data vs domain
• Dependency injection (Riverpod providers)
• Single source of truth in Firestore + relational store in PostgreSQL for historical/reporting data
Final checklist
[ ] All layers/components labeled
[ ] Architectural patterns (layering, feature modules) are evident
[ ] External dependencies (Firebase, Agora) visually distinct
[ ] CI/CD path from code → build → distribution included