How jamescardona11/wellness_score_app works
Project Type and Purpose
• Type: A mobile front-end application built with Flutter, following Clean Architecture (MVVM style)
• Purpose: Collect user input (income & expenses), compute a financial health score via a domain use-case, log analytics, and render results in two screens (calculator & result).
File Structure
• Top-level lib/ splits into:
– config/ → assets, constants, DI (GetIt), navigation (GoRouter)
– data/ → concrete repository implementations (e.g., MockAnalyticsRepository)
– domain/ → repository interfaces, types (HealthStatus), business logic (HealthScoreUseCase)
– ui/ → presentation layer
• core/ → theme system, shared widgets
• widgets/ → reusable UI controls
• features/ → feature modules (calculator & result) with Cubit state management and screens
• Entry Point: main.dart (app initialization, DI registration, GoRouter setup)
• Tests: mirror each layer for coverage.
README for Architectural Insights
• Layers: Presentation (UI + Cubit), Domain (UseCase), Data (Repository), External Service (Analytics)
• Cross-cutting: Dependency Injection via GetIt; Navigation via GoRouter; Theming with custom token system
• Business Flow: Input → UseCase → Analytics logging → UI update
a. Main Components:
1) Presentation Layer
– UI Screens: WellnessCalculatorScreen, WellnessResultScreen
– State Management: WellnessCalculatorCubit
– Shared Widgets & Theme
2) Configuration
– DI Container (di.dart)
– App Router (app_router.dart)
– Assets & Constants
3) Domain Layer
– HealthScoreUseCase
– HealthStatus enum
– AnalyticsRepository interface
4) Data Layer
– MockAnalyticsRepository (implements AnalyticsRepository)
5) External Services
– Analytics backend (e.g., Firebase Analytics or custom service)
b. Relationships and Data Flow:
1) main.dart initializes GetIt and GoRouter → injects dependencies into UI
2) User interacts with Calculator UI → triggers methods on WellnessCalculatorCubit
3) Cubit invokes HealthScoreUseCase (domain) with user inputs
4) UseCase computes score, calls AnalyticsRepository.trackEvent(...)
5) MockAnalyticsRepository forwards to external analytics service
6) UseCase returns HealthStatus → Cubit emits new UI state → navigates to WellnessResultScreen
c. Architectural Patterns and Principles:
• Clean Architecture: clear separation of concerns & dependencies point inward (UI → Domain → Data → External)
• MVVM: UI (View) binds to Cubit (ViewModel)
• Dependency Injection: decouples implementations from interfaces
• Single Responsibility: each layer has focused responsibilities
d. Key Technologies & Libraries:
• Flutter/Dart
• get_it for DI
• go_router for navigation
• flutter_cubit (Bloc package) for state management
• Custom theming tokens
• Mockito & flutter_test for testing