__brick__

{{app_name.titleCase()}}

Prerequisite

• Flutter 3.10.5
• Flutter version manager (recommend): fvm

Getting Started

Setup

• Create these .env files in the root directory according to the flavors and add the required environment variables. The example file is .env.sample.

  • Staging: .env.staging

  • Production: .env

• To make the Android release build,

  • put the release.keystore at the android/config folder,

  • create the signing.properties file to provide keystore credentials in the android folder. The example file is signing.properties.sample.

Run

• Run code generator for JSON models, DI dependencies, etc:

  • $ fvm flutter packages pub run build_runner build --delete-conflicting-outputs

• Run the app with the desired app flavor:

  • $ fvm flutter run --flavor staging
  • $ fvm flutter run --flavor production

• Check code formatting & static code analyzing:

  • $ dart format --set-exit-if-changed .
  • $ fvm flutter analyze .

Test

• Run unit testing:

  • $ fvm flutter test
  • $ fvm flutter test --machine --coverage

• Run integration testing:

  • $ fvm flutter drive --driver=test_driver/integration_test.dart --target=integration_test/{test_file}.dart --flavor staging

  • For example:

    $ fvm flutter drive --driver=test_driver/integration_test.dart --target=integration_test/my_home_page_test.dart --flavor staging

License

This project is Copyright (c) 2014 and onwards. It is free software, and may be redistributed under the terms specified in the LICENSE file.

About

This project is maintained and funded by Nimble.

We love open source and do our part in sharing our work with the community! See our other projects or hire our team to help build your product.