How azix-khan/expense-tracker works
Project Type and Purpose
• This is a cross-platform mobile/desktop/web application built in Flutter.
• It tracks daily expenses, using Bloc for state management and Firebase as its backend.
• A custom Dart package (expense_repository) encapsulates data-access logic and entities.
File Structure Analysis
• Top-level folders for each Flutter platform: android/, ios/, linux/, macos/, windows/, web/.
• lib/ holds the core application code:
• main.dart, app.dart, app_view.dart bootstrapping the app and routing.
• data/ for any local data abstractions.
• screens/ organized into feature modules (e.g., add_expense/, home/, stats/). Each module follows the Bloc pattern: separate folders for blocs/ (events, states, bloc classes) and views/.
• simple_bloc_observer.dart for global Bloc event/state logging.
• packages/expense_repository/ is a local package containing:
• entities/ (domain objects like ExpenseEntity, CategoryEntity)
• models/ (DTOs for Firebase, JSON)
• expense_repo.dart interface and firebase_expense_repo.dart implementation.
• Config files: pubspec.yaml, firebase config in Android (google-services.json) and iOS (Info.plist alterations).
a. Presentation Layer (Flutter UI)
• Platform Shells: Android, iOS, macOS, Windows, Linux, Web embedded Flutter shells.
• Widgets grouped by feature screens (Splash, Home, Add Expense, Stats).
b. State Management Layer
• Bloc instances per feature:
– GetExpensesBloc, CreateExpenseBloc, CreateCategoryBloc, GetCategoriesBloc.
c. Domain/Data Layer
• expense_repository package—exposes ExpenseRepository interface and returns domain entities.
d. External Services
• Firebase services (Firestore or Realtime Database) for persistence.
• Firebase Auth (if used for user identification).
Component Interactions
• UI Widgets dispatch Events → Bloc
• Bloc processes Events + current State → yields States
• Bloc calls ExpenseRepository methods (e.g., getExpenses(), createExpense(), getCategories(), createCategory())
• firebase_expense_repo implements repository calls → interacts with Firebase SDK
• Firebase returns data → maps to domain Entities → propagates back up to Bloc → UI
Architectural Patterns & Principles
• Layered Architecture: Presentation → State Management → Domain/Data → External
• Separation of Concerns: UI purely declares views; Blocs hold business logic; repository abstracts data source.
• Dependency inversion: Feature Blocs depend on abstraction (ExpenseRepository), not concrete Firebase implementation.
• Modularization: Local package isolates data layer, making it re-usable/testable.