Skip to main content

Set up the template

Starting a new project? Do this steps:

  • Set new package name. Replace all com.monterail.flutter.template strings to your desired package name, eg. com.company.app. Consider using rename to automate the process.

Important: You have to also rename a folder structure in android/app/src/main/kotlin from com/monterail/flutter/template to match the package name, eg. com/company/app (yes, you'll have to delete one level of directories). Without this change, built Android apps will not launch.

  • Create Android signing key with make create-android-signing.
  • Set Sentry DSN in environment/.dev-variables and environment/.prod-variables. It can be the same value, reported entries are tagged with development or production respectively.
  • Set proper APP_NAME in environment/.dev-variables and environment/.prod-variables. Development name should have an [dev] prefix to easily distinguish it from the prod app.
  • Replace appTitle in lib/src/localization/app_en.arb to actual app title.
  • Replace the app logo and update the splashscreen with make update-splashscreen.
  • Replace app icons for Android, iOS and web. You can use icon.kitchen generate the files.
  • Set proper project name in pubspec.yaml and replace all package:template occurances in Dart code to package:${your_app_name}.
  • Update web/index.html <title> tag to proper app title.
  • Update web/manifest.json name and short_name fields to proper app name. Also, consider updating description with something relevant.