App Flow | Set Up¶
Prerequisites¶
We recommend Android Studio for App Flow development due to its seamless Flutter integration, support for Android and iOS development, and powerful built-in tools for coding and debugging.
Flutter Requirements¶
- Flutter:
- Version 3.0.0 or higher
- Flutter Plugin:
- For Visual Studio IDE
- For JetBrains IDE
IDE and Plugin Recommendations¶
To enhance your development workflow and access additional tools, we recommend the following plugins:
-
AutoRoute Helper Plugin:
- For Visual Studio IDE
- For JetBrains IDE's
-
Riverpod Snippits Plugin:
- For Visual Studio IDE
- For JetBrains IDE
Installation¶
-
Clone The Repository: Download the App Flow project by cloning the repository from GitHub: App Flow
-
Open The Project: Launch the project in your preferred workspace or IDE.
-
Install Dependencies: In the terminal, run the following command to install all necessary dependencies:
-
Enable Code Generation: Run Build Runner to enable automatic code generation by executing:
-
Run The Project: Execute the following command to build and run the project:
Tip
To streamline your workflow, add dart run build_runner watch as a shell script in your Run Configuration: See Run Configurations Android Studio or Launch Configuration VS-Code. This way, you can more easily run Build Runner each time you launch the project.
Auto Generated Files¶
To keep your project files clean and organized, we recommend excluding auto-generated files from being displayed. Follow these steps in Android Studio:
-
Open Scopes Editor:
Navigate to Settings → Appearance & Behaviour → Edit Scopes. -
Create a New Scope:
Add a new scope and give it a descriptive name, such as Exclude Auto-Generated. -
Define Exclusion Pattern:
Use the following pattern to hide all.g.dartand.gr.dartfiles in thelibdirectory: ```bash !file:lib//.g.dart&&!file:lib//.gr.dart