Roadmap
This is an app to support achieving your goals.
Through this app, we aim to explore the optimal architecture for Flutter development and utilize it as a reference for future projects.
(โป Development paused as of December 2023)
๐ฆ Download

| Splash Screen |
Welcome Screen |
 |
 |
| Login Screen |
Signup Screen |
 |
 |
| Home Screen |
Empty Screen |
 |
 |
| Add Goal Screen |
Edit Screen |
 |
 |
| Add Roadmap Screen |
Edit Screen |
 |
 |
| Validation Error |
Delete Screen |
 |
 |
| Custom Screen |
Statistics Screen |
Settings Screen |
 |
 |
 |
๐ Demo
launch.mp4
|
login.mp4
|
home.mp4
|
logout.mp4
|
๐ Features
- Authentication (Sign up / Log in / Log out / Account deletion / Google Sign up)
- Goal setting (Add / Retrieve / Update / Delete)
- Roadmap creation (Progress tracking / Progress calculation)
- Visual display (Graphs / Animations)
- Notifications and reminders
๐ Tech Stack
1. Framework & Cloud Services
2. Used Packages
3. Development Features
- Version management with FVM
- Environment distinction with Dart-define-from-file
- Continuous Integration using GitHub Actions
- Dependency vulnerability monitoring with GitHub Dependabot
๐๏ธ Architecture / Folder Structure
MVVM with CleanArchitecture + Repository pattern
1. Reasons for Adoption
We adopted a combination of MVVM and Clean Architecture. MVVM is a UI design pattern, and Clean Architecture forms the overall architecture of the application. This combination allows us to create robust and scalable applications.
For state management in Flutter, tools like Riverpod are available, which can partially fulfill the role of MVVM's ViewModel. However, from an architectural perspective, we decided to adopt ViewModel to strengthen the loose coupling between UI logic and business logic.
2. Dependency Flow

3. Call Flow (Function and method call flow)
+-------------------------+
| Presentation: View |
+-------------------------+
|
V
+-------------------------+
| Presentation: ViewModel |
+-------------------------+
|
V
+-------------------------+
| Domain: Use Case |
+-------------------------+
|
V
+-------------------------+ +-----------------------------------------+
| Data: Repository |----->| Data Source: Remote for API or Firestore|
+-------------------------+ +-----------------------------------------+
4.Data Flow (Flow of data)
+-------------------------+
| Presentation: View |
+-------------------------+
^
|
+-------------------------+
| Presentation: ViewModel |
+-------------------------+
^
|
+-------------------------+
| Domain: Use Case |
+-------------------------+
^
|
+-------------------------+ +-----------------------------------------+
| Data: Repository |<-----| Data Source: Remote for API or Firestore|
+-------------------------+ +-----------------------------------------+
5. Folder Structure
Directory structure based on the principles of Clean Architecture. Designed to prioritize loose coupling and reusability, enhancing the independence of each layer.
The main goal of this structure is to center the application's core business rules while placing the more change-prone details on the periphery. This approach enhances the system's flexibility and durability. The Repository pattern conceals the details of data retrieval and persistence, simplifying data access throughout the application.
The aim is to increase loose coupling and reusability, making it easier to make changes and test each layer independently.
โโโ core/ // Core layer (utilities, constants, extensions)
โ โโโ config/
โ โโโ constants/
โ โโโ di/
โ โโโ utils/
โโโ domain/ // Domain layer (Entities, Repositories, Usecases)
โ โโโ entities/
โ โโโ repositories/
โ โโโ usecases/
โโโ data/ // Data layer (API, Firebase, Local DB)
โ โโโ datasources/
โ โ โโโ local/
โ โ โโโ remote/
โ โโโ mappers/
โ โโโ models/
โ โโโ repositories/
โโโ presentation/ // Presentation layer (Views, ViewModels)
โ โโโ routers/
โ โโโ viewmodels/
โ โโโ views/
โ โโโ widgets/ใใใใใใใใใ
โโโ main.dart