How webby813/fc-merchant works
Project Type and Purpose
• Type: Cross-platform mobile application (Flutter)
• Purpose: Merchant-side food-ordering client. Receives real-time orders from the fypuser platform, displays dashboards, lets merchants manage and update order statuses.
File Structure
• Top-level “android” and “ios” folders: platform-specific runner/stubs generated by Flutter.
• “lib” folder: core Dart code broken into:
• Firebase services (create_data.dart, retrieve_data.dart, update_data.dart, delete_data.dart, view_order.dart)
• Responsive UI layer (shared Cross-platform code + Mobile + Tablet views)
• SharedPref (local caching)
• Entry points (main.dart, login.dart, home.dart)
• Configuration files: pubspec.yaml, firebase.json, firebase_app_id_file.json.
README for Additional Insights
• Real-time order notifications → implies use of Firebase Cloud Messaging (FCM)
• Order CRUD → Cloud Firestore or Realtime Database as primary data store
• No backend code in repo → backend that pushes orders lives elsewhere (fypuser platform).
Main Components
a. Presentation Layer (Flutter UI)
• Component library widgets & styles
• Responsive layout controllers (mobile vs. tablet)
• Screens: Login, Dashboard, Order Details, Settings
b. Business Logic Layer (Dart services)
• FirebaseService – wraps CRUD operations & order retrieval
• NotificationService – handles FCM token registration & incoming messages
• SharedPrefService – local storage for tokens, user info, preferences
c. Data Layer / External Services
• Firebase Cloud Firestore (or RTDB) – order data store
• Firebase Cloud Messaging – push notifications
• Authentication (Firebase Auth, if used—token management)
• fypuser Platform (external backend) → writes orders into Firestore & triggers FCM
d. Platform Runners
• Android runner (Gradle, Kotlin MainActivity)
• iOS runner (Swift AppDelegate)
Relationships and Data Flows
• User taps UI → UI Layer invokes Business Logic Service (e.g., view_order.dart)
• Business Logic calls FirebaseService → reads/writes Firestore
• Firestore persists order data → updates propagate back to app (streams or queries)
• fypuser backend → pushes new order documents to Firestore & triggers FCM → NotificationService receives FCM payload → UI displays real-time alerts
• SharedPrefService caches auth tokens and preferences for quick access by UI & Services
Architectural Patterns
• Layered architecture (Presentation → Business Logic → Data)
• Responsive design pattern: single codebase, but conditional layouts for Mobile vs. Tablet
• Service-based abstraction for external dependencies (Firebase APIs)
• Reusable widget library for UI consistency
Final Checklist
• [ ] Node for fypuser external backend
• [ ] Nodes for Firestore & FCM under “External Services”
• [ ] Nodes for Shared Preferences and Firebase Auth (if used)