Flutter Base Template

Flutter base is a boilerplate project created by Rootstrap for new projects using Flutter. The main objective is helping any new projects jump start into feature development by providing a handful of functionalities.

Features

This template comes with:

• Melos: Manage actions.
• Dependency injection (GetIt).
• HttpClient already configured for Rootstrap BE Projects(Dio).
• Theming setup.
• Navigation Router and DeepLinks config with go_router
• Intl.
• State Management (Blocs/Cubit).
• Env config and flavors.
• Chat with Gemini and Vertex AI (Documentation and setup WIP)
• GitWorkflow config: RS-GPT-Review
• GitWorkflow config: Sonarqube

Initial Setup

1. Create a new repo using this template.

   

2. Clone your new repo.

3. Install Melos globally executing: dart pub global activate melos.

4. test: melos -v * note: if your terminal don't recognize melos command, you can add the following line to your .zshrc or .bashrc file:*

    export PATH="$PATH":"$HOME/.pub-cache/bin"

5. Run melos doctor.
6. Run melos pub:get.
7. Setup Android:
   • Add to the build.properties file (and update when needed):

    flutter.versionName=1.0.0
    flutter.appId=base
    flutter.versionCode=1
    flutter.compileSdkVersion=33
    flutter.minSdkVersion=21
    flutter.targetSdkVersion=33 

8. Android SignIn
   • Create your release Key Store:

   keytool -genkey -v -keystore ~/keystore_name.jks -keyalg RSA -keysize 2048 -validity 10000 -alias your_alias"

• Create the 'key.properties' file with the keystore information:

    storePassword=<YourStorePassword>
    keyPassword=<YourKeyPassword>
    keyAlias=<YourStoreAlias>>
    storeFile=<FilePath>

9. Add your env vars, create a config file for each env:
   • add the env config, i.e:

    {
        "API_URL": "https://dummyjson.com"
    }

10. Setup iOs App Name and id:

• Locate the config file for each flavor and configure the FLUTTER_APP_NAME i.e: Debug.xcconfig

     FLUTTER_APP_ID=base.debug
     FLUTTER_APP_NAME=RS Base Debug

Set up an editor

• Follow the Android Studio instructions to setup the editor

• Follow the VS Code instructions to setup the editor

Running the App

1. Open a Simulator or Emulator
2. Open your project in your editor of preference

Note: Starting with Flutter 2.8 in order for you to launch the app in Android you must define the flutter.compileSdkVersion inside the local.properties file.

You can read more about this here.

Android Studio

1. Add a Run Configuration
   1. Add new Flutter configuration
   2. Give it a meaningful name IE: Dev, QA, Staging, Prod
   3. Pick the entry point, main.dart file location IE: .../lib/main/env/main_dev.dart
2. Include any additional run arguments to launch the app.
   1. Create each env files config files in your root app/
   2. Setup your build, add the env file to the build command in AE:
3. Setup your env vars, i.e the api_url for each env:

       {
           "API_URL": "https://dummyjson.com"
       }
   

4. Select the device to launch the App
5. Run the App

VS Code

1. Go to Run and Debug section at the Activity Bar

2. At the top of the section expand the list and Add Configuration

3. Insert Flutter Launch configuration

   1. Update the environment name (dev)
   2. Update the launch program path /lib/main/env/main_dev.dart
   3. Update the Flutter Mode (debug, profile, release)
   4. Include any additional run argments to launch the app.

      1. Environment variables

         Add the env vars for each flavor with the property toolArgs

4. Inside the Run and Debug section select the environment you want to excute

5. Make sure you have the device you want to use already open

6. Run the App

Note 1: Create as much Launch Configurations as you need for any specific environment.

Note 2: You shouldn't commit the .vscode/launch.json file.

Build Production App:

1. Build your android appBundle or apk:

   • run the following command to build your appBundle

       flutter build appBundle -t lib/main/env/main.dart --dart-define-from-file=env_prod.json
   

   [TODO: add how to setup Xcode for apple signIn]

2. Configure your iOs app sigIn.

   • run the following command to build your ipa

       flutter build ipa --release -t lib/main/env/main.dart --dart-define-from-file=env_prod.json
   

For more information you can check the docs

Packages

• GetIt For dependency injection.
• Dio A http client.
• Blocs and Cubit as State management library.

Utilities

• intl and intl_utils for localization.
• flutter_svg Svg Image loader.

Code Quality Standards

In order to meet the required code quality standards, this project is following this tech guides considerations . It also runs flutter analyze for each build on your CI/CD tool.

Security recommendations

Obfuscation

TBD

CI/CD configuration with Bitrise (updated on Dec 12th 2021)

We are using Bitrise to configure and run the CI/CD pipelines

Github Actions: RS-GPT-Review

• Configure GPT secrets vars on your repo settings:
  • OPENAI_KEY

Note: The action will only run if the description or comments mentions @rs-gpt-review

Github Actions: Sonarqube

• Go to you sonarqube server and configure a new project.
• Configure the sonar-project.properties: example: ''' sonar.projectKey=your-app-key sonar.projectName=your-project-name sonar.host.url=https://your-sonarqube-server.net sonar.projectVersion=1.0 sonar.sourceEncoding=UTF-8 '''

Main source directories

sonar.sources=app/lib,modules/domain,modules/data,modules/common sonar.dart.exclusions=pubspec.yaml sonar.dart.analyzer.report.mode=LEGACY

• Configure Sonarqube secrets vars on your repo settings:
  • SONAR_TOKEN (your sonarqube project token)
  • SONAR_URL (your sonarqube server url)

License

Flutter-Base is available under the MIT license. See the LICENSE file for more info.

NOTE: Remove the free LICENSE file for private projects or replace it with the corresponding license.

Credits

Flutter Base is maintained by Rootstrap with the help of our contributors.