How viethoangtran/quickstep_app works
Main Components
• Mobile Frontend: The Flutter codebase (primarily organized in the "lib" directory) includes UI (screens, widgets), controllers (using GetX for state management), models, and services (e.g., auth_service, db_service, hive_service). Notice that separate platform-specific directories (“android” and “ios”) provide native setup details.
• Backend Server: Even though its code isn’t in the repository, the README points to a Node.js backend. Represent this as a separate component handling authentication, real-time socket communication (using socket.io), and business logic.
• External Services: List Google Maps APIs (with custom markers, live tracking) and email services for account verification (OTP features).
• Local Storage & Utilities: Include components like Hive (for persistence) and other utilities that support local caching and offline operations.
Relationships and Interactions
• Mobile Components Internal Flow: Break down the mobile app into its major layers:
– UI Layer: Comprising various screens (authentication, home, movements, notifications, profile) and widgets.
– Controller/Business Logic Layer: Represented by controllers (in "lib/controllers") and state management (using GetX).
– Service Layer: Handling external communications like network requests (Dio) and local data storage (Hive).
– Models: Representing data structures (user, account, movement, etc.) that are used by controllers and screens.
• Integration with Google Maps: Emphasize that the mobile app integrates with Google Maps (API keys configured in AndroidManifest.xml and AppDelegate.swift) for live location tracking.
Architectural Patterns and Design Principles
• Separation of Concerns: Clearly separate the UI, business logic, and data layers.
• Cross-platform Development: Emphasize the Flutter structure that allows unified UI code but with separate configuration for Android and iOS.
• Real-time Communication: Capture the use of Socket.io for live chat and location updates.
• State Management: Mark the use of GetX pattern for handling state across the app.
• Offline/Local Storage: Include how Hive is used to store data locally when needed.
Relevant Technologies and Frameworks
• Flutter / Dart for mobile app development.
• GetX for state management.
• Dio for network requests.
• Hive for local storage.
• Google Maps API for mapping and location tracking.
• Socket.io for real-time communication.
• Node.js for backend service (external integration).
Essential Elements
– User interactions triggering API calls to the backend.
– Real-time socket connections between the mobile app and the Node.js backend.
– Data retrieval from local storage via Hive.
– Map data fetched from Google Maps.
• Annotations: Brief notes on the responsibilities of each layer/component (e.g., "Auth service handles login, registration, OTP verification" or "Movements controller manages real-time location updates").