Flutter Template

A Flutter skeleton using Clean Architecture, the Bloc state management solution and Sembast.

Installation

npx degit mj12358/flutter-template myapp

Getting Started

This project is a starting point for a Flutter application that follows clean architecture, bloc state management and uses sembast for data storage.

For help getting started with Flutter development, view the online documentation, which offers tutorials, samples, guidance on mobile development, and a full API reference.

Assets

The assets directory houses images, fonts, and any other files you want to include with your application.

The assets/images directory contains resolution-aware images.

Localization

This project generates localized messages based on arb files found in the l10n directory.

To support additional languages, please visit the tutorial on Internationalizing Flutter apps

Changing the App Name

This project includes change_app_package_name and flutter_app_name to aid in changing the app/package name.

First modify pubspec.yaml:

name: <your_app_name>

flutter_app_name:
  name: <your_app_name>

Then run:

dart run flutter_app_name

dart run change_app_package_name:main com.company.myappname

You can then use find and replace (via your favorite editor) to modify any import references from the old name to the new one.

Changing Launcher Icons

This project includes flutter_launcher_icons to aid in generating the necessary icons.

First determine which icon you want to use. Place it into the assets folder and modify the pubspec.yaml file to fit your needs.

flutter_launcher_icons:
  android: true
  image_path: "assets/logos/launcher.png"

Then run:

dart run flutter_launcher_icons:main

Changing the Splash Screen

This project includes flutter_native_splash to aid in generating the necessary images.

First determine which image you want to use. Place it into the assets folder and modify the pubspec.yaml file to fit your needs.

flutter_native_splash:
  android: true
  image: assets/logos/splash.png

Then run:

dart run flutter_native_splash:create

Signing Your App

A convenience script is located in the scripts folder for generating a new keystore.

Move the generated keystore into android/app and create a android/key.properties file with the following:

storePassword=yourSuperSecretPassword
keyPassword=yourSuperSecretPassword
keyAlias=release
storeFile=keystore.jks

Initializing Firebase

Firebase Crashlytics is built into this project but can be easily removed if not needed.

To initialize run the following:

flutterfire configure

Signing Report

First you must build the app, then the signing report will become available.

cd android
gradlew signingReport

Widgets (optional)

There are some widgets shipped with this template that you may want to rename.

• FlutterTemplateBottomNavigation
• FlutterTemplateSideNavigation