How mnengineer/roadmap works
Main Components
• Frontend (Presentation Layer):
• Contains UI components such as views (login_screen, home_screen, etc.) and widgets.
• Includes the ViewModels (found under lib/presentation/viewmodels) which handle UI logic.
• Uses routing (go_router in lib/presentation/routes) for navigation.
• Domain Layer:
• Contains business rules like Entities, UseCases, and repository interfaces (in lib/domain/).
• Acts as the core of the app’s logic (e.g., goal and roadmap use cases).
• Data Layer:
• Implements the repository interfaces (in lib/data/repositories) and connects to data sources.
• Contains both Remote (Firebase integration in lib/data/datasources/remote) and Local data sources.
• Core Utilities:
• Includes configuration, constants, dependency injection, and common utilities (in lib/core/).
• External Services:
• Firebase for Authentication, Firestore, Cloud Functions, and Cloud Storage.
• Third-party packages like hooks_riverpod for state management and google_sign_in for authentication.
• Platform-specific Code:
• Android (android/) and iOS (ios/) folders, ensuring the Flutter app is correctly built and deployed on each platform.
Dependency and Data Flows
• For the call flow: View → ViewModel → UseCase → Repository → Data Source.
• For the data flow (reverse): Data Source → Repository → UseCase → ViewModel → View.
Architectural Patterns
• MVVM Pattern:
• Separation between View (UI), ViewModel (presentation logic), and how they interact with Domain/UseCases.
• Clean Architecture:
• Separation of concerns by dividing the system into Core, Domain, and Data layers.
• Dependency direction – inner layers (Domain) should be independent of outer layers (Data and Presentation).
Essential External Dependencies
• Cloud Services:
• Firebase services (Auth, Cloud Firestore, Cloud Functions, Storage) as external services that the Data layer reaches out to.
• Third-Party Libraries:
• Mention state management (hooks_riverpod, flutter_hooks), routing (go_router), etc., which affect the Presentation and overall architecture.