MoneyFlow is a comprehensive personal finance management application built with Flutter following Clean Architecture principles. This project demonstrates professional-grade code structure, SOLID principles, and modern Flutter development practices.
- 🏗️ Clean Architecture - Separation of concerns with Domain, Data, and Presentation layers
- 📊 Beautiful Visualizations - Interactive charts and graphs to understand spending patterns
- 💰 Budget Management - Set and track budgets per category
- 🔥 Firebase Integration - Cloud sync, authentication, and real-time updates
- 📱 Cross-Platform - Works on Android, iOS, and Web
- 🔒 Secure - Firebase Authentication with email/password
- ☁️ Cloud Sync - Data synced across all devices
- 🎨 Material Design 3 - Modern and intuitive UI
- Project Setup
- Clean Architecture structure (Domain/Data/Presentation)
- Firebase integration (Auth, Firestore)
- Git workflow with professional commits
- Domain Layer (Auth Feature)
- User Entity with validation and immutability
- AuthRepository Interface (login, register, logout, getCurrentUser)
- 4 Use Cases: LoginUser, RegisterUser, LogoutUser, GetCurrentUser
- Dependency Injection pattern
- Data Layer (Auth Feature - In Progress)
- UserModel with JSON and Firebase conversion
- fromFirebase, fromJson, toJson methods
- Data Layer (Auth Feature)
- AuthRemoteDataSource (Firebase calls)
- AuthRepositoryImpl (Repository implementation)
- Presentation Layer (Auth Feature)
- Login Screen
- Register Screen
- State management with Riverpod
- Transaction management (Add, Edit, Delete)
- Category management
- Budget tracking
- Statistics dashboard with charts
- Receipt scanning with OCR
- Export to PDF
- Multi-currency support
- Recurring transactions
- Dark mode
- Biometric authentication
- Framework: Flutter 3.x
- Language: Dart 3.x
- State Management: Riverpod 2.x
- Architecture: Clean Architecture
- Authentication: Firebase Auth
- Cloud Database: Cloud Firestore
- Storage: Firebase Storage (planned)
- Local Cache: Hive (planned)
- Version Control: Git & GitHub
- Code Style: Dart conventions
- Architecture Patterns: Repository Pattern, Dependency Injection, Use Cases
- Principles: SOLID, DRY, Clean Code
This project follows Clean Architecture principles with strict separation of concerns:
lib/
├── core/ # Shared code
│ ├── constants/ # App constants
│ ├── utils/ # Utility functions
│ └── errors/ # Custom errors
│
└── features/
└── auth/ # Authentication feature
│
├── domain/ # ✅ COMPLETE - Business Logic Layer
│ ├── entities/
│ │ └── user.dart # User entity with validation
│ ├── repositories/
│ │ └── auth_repository.dart # Repository interface
│ └── usecases/
│ ├── login_user.dart # Login use case
│ ├── register_user.dart # Register use case
│ ├── logout_user.dart # Logout use case
│ └── get_current_user.dart # Get current user use case
│
├── data/ # 🚧 IN PROGRESS - Data Layer
│ ├── models/
│ │ └── user_model.dart # ✅ User model with conversions
│ ├── datasources/
│ │ └── auth_remote_datasource.dart # ⏳ Firebase calls (next)
│ └── repositories/
│ └── auth_repository_impl.dart # ⏳ Repository implementation (next)
│
└── presentation/ # ⏳ TODO - UI Layer
├── providers/ # Riverpod providers
├── screens/ # Full screens
└── widgets/ # Reusable widgets
✅ Testability - Each layer can be tested independently
✅ Maintainability - Clear structure, easy to navigate
✅ Scalability - Easy to add new features
✅ Flexibility - Can change implementations without affecting other layers
✅ Independence - Domain layer has zero dependencies on external frameworks
🎯 Domain Layer (Business Logic)
- Defines what the app does
- Contains entities (business objects)
- Defines repository contracts
- Implements use cases (business rules)
- Framework-independent (pure Dart)
💾 Data Layer (Data Management)
- Implements repository contracts
- Handles data sources (Firebase, APIs, local DB)
- Converts between models and entities
- Manages caching and synchronization
🎨 Presentation Layer (User Interface)
- Displays data to users
- Handles user interactions
- Manages UI state with Riverpod
- Calls use cases, never repositories directly
User Entity
- Immutable data class with id, email, displayName
- Constructor validation (empty checks, email format)
- copyWith method for updates
- Proper equals and hashCode
Repository Interface
- login(email, password) → Future
- register(email, password, displayName?) → Future
- logout() → Future
- getCurrentUser() → Future<User?>
Use Cases
- LoginUser - Handles user login
- RegisterUser - Handles user registration
- LogoutUser - Handles logout
- GetCurrentUser - Gets currently logged in user
- All use cases implement Dependency Injection
Concepts Applied
- Clean Architecture principles
- SOLID principles
- Repository Pattern
- Dependency Injection
- Use Case Pattern
- Future/async/await
- Immutability
UserModel ✅
- Extends User entity
- fromFirebase(firebase_auth.User) - Converts Firebase user
- fromJson(Map) - Converts from JSON
- toJson() - Converts to JSON
- Factory constructors for conversions
Next Steps ⏳
- AuthRemoteDataSource - Direct Firebase calls
- AuthRepositoryImpl - Connect Domain to Data
- Project setup with Clean Architecture
- Firebase configuration and integration
- Domain Layer complete (Entity, Repository, Use Cases)
- UserModel with conversions
- DataSource and Repository implementation
- Authentication screens (Login/Register)
- Complete Authentication flow with UI
- Transaction management (CRUD)
- Category system
- Basic statistics
- Budget tracking and alerts
- Charts and visualizations
- Data export (PDF, CSV)
- Dark mode
- Animations and UI polish
- Testing (Unit, Widget, Integration)
- Performance optimization
- Deploy to Google Play / App Store
- Flutter SDK (>= 3.0.0)
- Dart SDK (>= 3.0.0)
- Firebase project configured
- Android Studio / VS Code
- Git
- Clone the repository
git clone https://github.com/CLopes86/money-flow.git
cd money-flow- Install dependencies
flutter pub get-
Configure Firebase
- Create a Firebase project at Firebase Console
- Enable Email/Password authentication
- Create Firestore database
- Download and add
google-services.json(Android) toandroid/app/ - Download and add
GoogleService-Info.plist(iOS) toios/Runner/
-
Run the app
flutter runThis project showcases professional Flutter development practices:
- Clean Architecture - Three-layer separation (Domain/Data/Presentation)
- SOLID Principles - Single Responsibility, Dependency Inversion, etc.
- Repository Pattern - Abstract data sources behind interfaces
- Use Cases - Isolated business logic
- Dependency Injection - Loose coupling between layers
- Factory Constructors - Object creation patterns
- async/await - Asynchronous programming
- Future & Stream - Reactive programming concepts
- Riverpod - Modern state management
- Firebase Integration - Auth, Firestore, Storage
- Testing - Unit tests, widget tests
- Error Handling - Either type, custom exceptions
- Advanced UI - Animations, custom painters
- ML Kit - OCR for receipt scanning
- Performance - Optimization techniques
- CI/CD - Automated testing and deployment
This project is licensed under the MIT License - see the LICENSE file for details.
🎓 3rd Year - Informatica & Multimedia @ IPCB
💻 Mobile Developer | Flutter Enthusiast
🚒 Volunteer Firefighter since 2023
🚀 Building professional-grade applications
📍 Portugal | 🌐 Open to opportunities
