How mjaber5/qanoni-app works
Project type and purpose
• Qanoni-App is a cross-platform (Android, iOS, Web, Windows, macOS, Linux) mobile application built with Flutter.
• It follows a Clean MVVM architecture: UI → ViewModel (Bloc/Cubit) → Services → Data → External.
• Backend is provided by Firebase (Authentication, Firestore, Cloud Storage) plus a Node.js layer for custom logic (e.g., Cloud Functions).
File structure
• Top-level “android/”, “ios/”, “web/”, “windows/”, “macos/”, “linux/” directories: platform-specific Flutter embedder code.
• “lib/”: the main Flutter code organized into:
• core/ – shared services (api_services.dart), utilities, theme, widgets, errors
• features/ – feature modules (authentication, home/contracts, payment, chatbot, notification, profile, splash, theme, languages) each subdivided into data (models/repos), presentation (views, blocs/cubits), etc.
• packages/user_repository – a Dart package encapsulating user-related domain entities and repository interfaces.
• Configuration files (pubspec.yaml, firebase.json, analysis_options.yaml) and test/ for unit/widget tests.
README
• Confirms Clean MVVM, Flutter frontend, Firebase backend, Firestore DB, Firebase Auth/Storage, Node.js micro-services.
• Features: electronic contract creation, templates, security, multi-platform.
Components
a. Frontend (Flutter App)
• Platform Embedders (Android, iOS, Web, Desktop)
• Flutter Engine
• Presentation Layer: Views (Widgets), ViewModels (Bloc/Cubit)
• core/services/api_services.dart – HTTP / RPC calls abstraction
• packages/user_repository – domain-level repo interface
b. Domain & Data
• Repositories (FirebaseUserRepo, ContractRepo, NotificationRepo, etc.)
• Data Models & Mappers
c. External Services
• Firebase Authentication
• Firestore Database
• Firebase Cloud Storage
• Node.js Cloud Functions / REST API (if present)
d. Third-party SDKs & Plugins
• FlutterFire plugins (auth, firestore, storage)
• Any payment gateway or chat APIs (if used)
Relationships & Data Flow
• User taps UI → View (Widget) invokes ViewModel event
• ViewModel calls core/services (ApiServices) or calls Repository interface
• Repository implementation uses Firebase SDK or HTTP to Cloud Functions
• Firebase Auth returns credential → Firestore reads/writes Contract documents → Cloud Storage stores attachments → results bubble back up to ViewModel → UI updates
Architectural patterns & design principles
• Clean MVVM: strict separation of concerns
• Feature-based modularization: each feature has its own data & presentation packages
• Dependency inversion: ViewModels depend on abstract Repos, not concrete Firebase classes
• Single responsibility: services/api_services.dart handles networking; repositories handle data persistence
• Testability: each layer can be mocked or stubbed