flutter_boilerplate

Flutter Boilerplate: An Overview

Flutter Boilerplate is a starter template meticulously designed for developing production-ready Flutter applications that work with a REST backend. Its principal aim is to streamline the project's initial setup, enabling developers to embark on their software development journey swiftly and efficiently.

What Flutter Boilerplate Offers

This template serves as a scaffold for crafting a production-ready application, complete with features such as automatic icon and splash screen generation, REST boilerplate, and integrated analytical and performance reporting. It perfectly suits developers eager to bypass the mundane and repetitive tasks associated with setting up a new project, allowing them to focus on writing code.

What Flutter Boilerplate is Not

Flutter Boilerplate deliberately avoids imposing specific preferences on state management and app architecture. The template does not dictate how these aspects should be handled, granting developers the flexibility to implement their desired state management approaches and architectural styles. Alternatively, they can fork the repository and tailor the template to their preferences. While the current version refrains from dictating these opinions, there is potential for future branches to include the author's architectures and state management suggestions.

Getting Started: Step-by-Step

1. Acquiring the Template

   • Developers can either click “Use this template” on GitHub to create new projects or clone the repository to their local machines.

2. Installing Dependencies

   • Execute flutter pub get to download and install necessary dependencies.

3. Changing Application Bundle Name

   • To personalize your app's package name for both Android and iOS, utilize the flutter pub run change_app_package_name:main <com.new.package.name> command. The change_app_package_name package facilitates this process.

4. Renaming Application

   • Manually modify your application's name in Info.plist for iOS and AndroidManifest.xml for Android. Update the name and description fields in pubspec.yaml as well.

5. Generating App Icons

   • Use the flutter_launcher_icons package to automatically generate app launcher icons. After adding your desired image to assets/icon/icon.png, run flutter pub run flutter_launcher_icons.

6. Creating Splash Screens

   • The flutter_native_splash package assists in generating native splash screens. Add a splash image to assets/splash/splash.png, adjust the background color in pubspec.yaml, and execute flutter pub run flutter_native_splash:create.

7. Setting Environment Variables

   • Utilize the envied package for configuring environment variables. This capability allows for seamless switching between different environments (e.g., production, staging) using .env files, which should be placed in the project's root directory and are .gitignored for security purposes.

8. Integrating Firebase Reporting

   • Set up Firebase Analytics, Performance, and Crashlytics by creating a Firebase project and downloading GoogleService-Info.plist & google-services.json, placing them in their respective iOS and Android folders. The required configuration is pre-established within the template.

9. Handling TODOs

   • Address any TODO items found within the lib folder to complete initial setups or enhancements.

10. Starting Development

• With foundational configurations in place, developers are set to commence building their applications.

11. Deploying the Application

• Prior to releasing an Android app, ensure it is properly signed using a generated Keystore file. Update android/key.properties with the necessary Keystore credentials.

12. Finishing Touches

• Upon completing these steps, the setup is complete, allowing developers to start enjoying the streamlined Flutter development experience.

Packages Utilized

Flutter Boilerplate incorporates an array of packages to extend its functionality, including but not limited to:

• change_app_package_name: Simplifies package name changes.
• dio and dio_http_cache: Enhances HTTP client operations with caching.
• firebase_analytics, firebase_crashlytics, firebase_performance: Facilitates data analytics and performance monitoring.
• flutter_launcher_icons and flutter_native_splash: Automatizes the creation of app icons and splash screens.

Every aspect of Flutter Boilerplate is tailored to minimize the daunting challenges of foundational Flutter application setup, making it an invaluable tool for developers aiming to maximize productivity and focus on enriching app development.