Skip to content

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

IDE and Plugin Recommendations

To enhance your development workflow and access additional tools, we recommend the following plugins:

Installation

  1. Clone The Repository: Download the App Flow project by cloning the repository from GitHub: App Flow

  2. Open The Project: Launch the project in your preferred workspace or IDE.

  3. Install Dependencies: In the terminal, run the following command to install all necessary dependencies:

    flutter pub get
    

  4. Enable Code Generation: Run Build Runner to enable automatic code generation by executing:

    dart run build_runner watch
    

  5. Run The Project: Execute the following command to build and run the project:

    flutter run
    

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:

  1. Open Scopes Editor:
    Navigate to Settings → Appearance & Behaviour → Edit Scopes.

  2. Create a New Scope:
    Add a new scope and give it a descriptive name, such as Exclude Auto-Generated.

  3. Define Exclusion Pattern:
    Use the following pattern to hide all .g.dart and .gr.dart files in the lib directory: ```bash !file:lib//.g.dart&&!file:lib//.gr.dart