icapps / flutter-template

A Flutter Template to get started quickly

Flutter Template

• dependency injection (injectable/get it)
• network layer (dio)
• network logging (niddler, dio)
• viewmodels (provider)
• translations (icapps translations)
• json serialization (json_serializable)
• different environments
• themes
• navigator
• linting (flutter analyze)

Update the translations

A custom dart program is used for updating the translations

https://pub.dev/packages/icapps_translations

Update your config in the pubspec.yaml

icapps_translations:
  api_key: 'enter-your-api-key'
  default_language: 'nl'
  languages: ['en', 'nl']

Add your locale folder to your flutter config

flutter:
  assets:
    - assets/locale/

Command to run to update the translations

fvm flutter packages pub run icapps_translations

Json Serializable & Kiwi

fvm flutter packages pub run build_runner build --delete-conflicting-outputs
fvm flutter packages pub run build_runner watch

Environments

--release is not available for emulators. Performance will be better

Dev, Debug

fvm flutter run --flavor dev -t lib/main.dart

fvm flutter run --release --flavor dev -t lib/main.dart

Dummy

Note: a hot reload is required after launch to use the correct launch file.

fvm flutter run --flavor dev -t lib/main_dummy.dart

fvm flutter run --release --flavor dev -t lib/main_dummy.dart

Alpha

fvm flutter run --flavor alpha -t lib/main_alpha.dart

fvm flutter run --release --flavor alpha -t lib/main_alpha.dart

Beta

fvm flutter run --flavor beta -t lib/main_beta.dart

fvm flutter run --release --flavor beta -t lib/main_beta.dart

Prod, Release

fvm flutter run --flavor prod -t lib/main_prod.dart

fvm flutter run --release --flavor prod -t lib/main_prod.dart

Niddler

https://github.com/Chimerapps/niddler_dart

Niddler is a network tracing tool written by Nicola Verbeeck. An Android Studio and Intelij plugin is available to download in the plugin store. (https://plugins.jetbrains.com/plugin/10347-niddler - https://github.com/Chimerapps/niddler-ui) Niddler is also available for Android & Java (OkHttp: https://github.com/icapps/niddler)

Linting

To check your code matches our linting. The analysis_options.yaml contains all our code checks.

flutter analyze

Testing

In order to run our test we need to run

fvm flutter test

If we want to update our golden files we need to run

fvm flutter test --update-goldens

Fastlane

Fastlane is used for building iOS and Android

Transform this template project

Rename this project

This script will run a dart script. The dart script itself will ask you some input to complete the full rename

./tool/rename_project.sh

Add provisioning files

Add the provisioning profiles in the ios/provisioning/ folder. The naming of the files should be the same as provided in the ios/Configuration/{flavor}.xcconfig files (underscore will be replaced with a space in the configuration files)

Firebase

To setup firebase you will need to create a new firebase project with 8 new apps, 1 for each flavor on both iOS and Android.

When creating the iOS apps on firebase you will be able to download a GoogleService-Info.plist file which you will need to rename according to the flavor you just created an app for e.g.: You just created the iOS App for the Dev flavor so your file should be named GoogleService-Info-dev.plist. Each .plist file you download from firebase needs to be placed in the ios/Configuration/GoogleService/ folder. Whenever the project is run with a different flavor from the currently active flavor, it will automatically copy the correct GoogleService-Info-{flavor}.plist file into the ios/Runner/ folder.

When creating the Android apps you will be able to download a google-services.json file, you only need to download this file once at the end of the last Android app setup on firebase. This .json file contains all the configurations for the 4 Android apps which you just created. Add the .json file in the android/app/src/ folder.

Languages

Configure the required languages in Xcode

icapps Translations

Update the translations.py file (edit the todos)

Obfuscation

Obfuscation is enabled by default when using fastlane for building. The symbol files are stored in ./build/debug-info/#{options[:flavor]}

Important: Add the following regex to jenkins configuration to also archive the symbol files

**/*.symbols

Icons

Replace the files in the assets_launcher_icons/** folder.

You can also change the adaptive_icon_background in the flutter_launcher_icons-{flavor}.yaml (currently "#CB2E63") (only available for Android 8.0 devices and above)

After this, run the following command

fvm flutter pub run flutter_launcher_icons:main -f flutter_launcher_icons-dev.yaml

Common issues

No flavor provided

Add a flavor to your configuration. Extra info can be found in this issue -> #3

Questions?

For question contact William Verhaeghe

Finish

When you have completed this readme. Replace it with the readme for your project.

flutter-template's Issues

Add wiki docs

Disable ipad support by default

Because most apps only support mobile we should disable ipad by default. If for a specific project we do need ipad support the developer should enable it himself

remove keychain on new install

Use your viewmodel for getting correct value in a list

ListView.builder(
                padding: const EdgeInsets.all(ThemeDimens.padding16),
                itemCount: value.data.length,
                itemBuilder: (context, index) {
                  final item = value.data[index];
                  return UserRow(
                    title: item.name,
                    titleIcon: Icons.person,
                    subtitle: item.address.street,
                    subtitleIcon: Icons.location_city,
                    onClick: value.onUserClicked,
                  );
                },
              );

item.location_city & item.person should come from your viewmodel

Add support for Flavored names

Add support for configurable Names per Flavor

Flutter Template Debug
Flutter Template Alpha
Flutter Template Beta
Flutter Template

Wrong folder structure

In the android template, the folder structure states: 'flutte_template' instead of 'flutter_template'. This conflicts with the package definition of MainActivity.kt

The interceptors should extend Interceptor instead of InterceptorWrapper

The interceptors should extend Interceptor instead of InterceptorWrapper

Failed to run template project. Specify --flavor

Initializing gradle...
Resolving dependencies...

The Gradle project does not define a task suitable for the requested build.
The android/app/build.gradle file defines product flavors: alpha, beta, dev, prod
You must specify a --flavor option to select one of them.
Finished with error: Gradle build aborted.

Add the option --flavor to make sure you run one of the allowed flavors

https://medium.com/@salvatoregiordanoo/flavoring-flutter-392aaa875f36

Add the white and back statusbar widgets

Add the white and back statusbar widgets

Fix deprecated text styles

Template does not compile with strong mode enabled

The template project should compile with strong mode analysis enabled

Add a native brdige

example

Add avoid_print to flutter analyzer

linter:
rules:
- avoid_print

Add prefer_collection_literals to the analysis_options.yaml

https://dart-lang.github.io/linter/lints/prefer_collection_literals.html

Fix the test coverage

Niddler error

After cloning the repo, running "flutter packages get" I tried to run the app but I got this error:

lib/niddler.dart:13:3: Error: Getter not found: 'NiddlerInjector'.
  NiddlerInjector.install(niddler);
  ^^^^^^^^^^^^^^^

To fix this I had to replace this line:

NiddlerInjector.install(niddler);

with

niddler.install()

Add error handling with error code status

Allow support for error handling with a specific error code So it can be displayed in the UI

Update to androidx

Update the android project to use android x instead of the support libraries

CombiningSmartInterceptor is never used

Dio provideDio(CombiningSmartInterceptor interceptor) {
  final dio = Dio();
  dio.options.baseUrl = FlavorConfig.instance.values.baseUrl;
  dio.interceptors.add(interceptor);
  return dio;
}

@Register.singleton(NetworkLogInterceptor)
@Register.singleton(NetworkAuthInterceptor)
@Register.singleton(NetworkErrorInterceptor)
@Register.singleton(NetworkRefreshInterceptor)

Update list of all the features added in this template project

update packages

Disable scalable fonts.

Add this around in the build method of the mainnavigator

    final mediaQuery = MediaQuery.of(context);
    return MediaQuery(
      data: mediaQuery.copyWith(textScaleFactor: 1),
      child: ,
    );

allowBackup should be false by default

By default the app keeps it's saved values even if the app was removed and reinstalled. For most cases we don't want that. so allowBackup should be set to false for android

Check 1.17.0 support

fastlane add appcenter group support

Refresh interceptor should throw an unimplemented error

If there is no custom implementation we should throw an error

bump version number in fastlane

Replace BUILD_NR = ENV["BUILD_NUMBER"] with this:

BUMP_BUILD_NR = 0
BUILD_NR = ENV["BUILD_NUMBER"] || ''

if BUILD_NR == ''
  sh("echo","No build nr set")
else
  BUILD_NR = Integer(BUILD_NR) + BUMP_BUILD_NR
  sh("echo","New build nr: #{BUILD_NR}")
end

Fastlane ensure latest flutter version is installed on jenkins

Set to the latest version

FLUTTER_VERSION = '1.20.1' # Configure if you want to use a specific version.
FLUTTER_CHANNEL = 'stable' # Configure if you want to use a specific channel.


private_lane :ensureFlutterVersion do
    #sh("flutter", "channel", FLUTTER_CHANNEL)

    if FLUTTER_VERSION == ""
        sh("echo", "No specific version specified. We will use the latest version")
        sh("flutter", "upgrade", "--force")
    else
        # First we check if the current version is the specified version
        begin
            sh("flutter --version | grep -o 'Flutter #{FLUTTER_VERSION}'")
        rescue => ex
            sh("echo", "Current version is not v#{FLUTTER_VERSION}, So we will first upgrade")
            sh("flutter", "upgrade", "--force")
        end

        # We check again if we are not on the specified version.
        begin
            sh("flutter --version | grep -o 'Flutter #{FLUTTER_VERSION}'")
        rescue => ex
            # We are not yet on the specified version so let's downgrade.
            begin
               sh("flutter", "downgrade", "v#{FLUTTER_VERSION}")
            rescue => ex
               raise ex unless ex.message.include?('There is no previously recorded version for channel ')
               sh("echo", "We will use the latest version of flutter anyway")
               sh("flutter", "upgrade", "--force")
            end
        end
    end
    sh("flutter", "doctor", "-v")
end

fix the fastlane file

alpha_ci
beta_ci
pr

provisioning profiles

Add target platform as a debug option

Add a debug option to the debug screen
to switch between: android, ios and system default for UI interaction.

Add app store support for fastlane

Dio interceptors should be in a separate file

Move the interceptors to a separate file.
this injector.dart is purly to create object and bind them together.

Update readme to the new translation tool

Update readme to the new translation tool

remove the phyton script documentation and add the run command for dart

add hero controller to the observers

add hero controller to the observers of the mainnavigator widget (navigator itself)

Create a kiwicontainer to prevent 2 containers

Create a kiwi container to use auto imports.

DEV => DEBUG

Multi Flavor jenkins/fastlane build does not work correctly

Debug.dev is always build first.

This is due to the default command-line build configuration set by xCode

Related issue: flutter/flutter#18342

Add wrapped logger to the logger class

void printWrapped(String text) {
  final pattern = RegExp('.{1,800}'); // 800 is the size of each chunk
  pattern.allMatches(text).forEach((match) => print(match.group(0)));
}

Fix issues from 1.12 upgrade

-main navigator widget linting error.
-niddler widget bindings
-center const

Test setup

Testup setup should be included in the template as well.

Add slowmotion option. for debuging animations

Add an extra debug screen with a toggle to turn slowmotion on or off

Add a no internet check to the error interceptor

Add support for retrofit.dart

https://github.com/trevorwang/retrofit.dart/

Can use Dio with dependency injection

Update kiwi versions

Update kiwi -> 1.1.0
kiwi_generator -> 1.0.0

PRODUCTION => PROD

Change the Flavor

Add playstore support for fastlane

Add support for Flutter 1.20 & dart 2.9.0

Add support for dart extensions

Add appbundle lane to fastlane

private_lane :buildAppBundleAndroid do |options|
    Dir.chdir ".." do
      sh("flutter", "build", "appbundle", "--release", "--flavor", options[:flavor], "-t" "lib/main_#{options[:flavor]}.dart", "--build-number=#{BUILD_NR}")    # Build the application
    end
end

Template uses debug/res/values/strings.xml

This should be used in dev instead of debug