Flutter Starter Kit

screenshot of Flutter Starter Kit

Flutter Starter Kit

A Flutter Starter Kit (Boilerplate) to kick-start your next Android and iOS app

Overview

The Flutter Starter Kit is a boilerplate application that utilizes the BLoC (Business Logic Component) Pattern. It provides a centralized place to manage colors/branding and constants/URL/keys. The project is logically and naturally organized with different folders for APIs, blocs, models, repositories, responses, utilities, views, and partials. It also includes features like Google AdMob and Firebase FCM integration, sample pages, and a marketplace for buying products and merchandise.

Features

  • Centralized place to manage application's colors/branding and constants/URL/keys
  • BLoC Pattern for fetching and posting data over the internet
  • Logically & naturally organized files & folders
  • API folder for common API concerns
  • Blocs folder for managing streams of data
  • Models folder for holding models
  • Repositories folder for CRUD operations
  • Responses folder for handling response data
  • Utilities folder for holding utility files
  • Views folder for managing UI
  • Partials folder for commonly used widgets
  • Google AdMob integration
  • Firebase FCM integration
  • Sample pages included

Installation

  1. Clone the project repository: git clone git@github.com:lexxyungcarter/flutter-starter-kit.git myapp
  2. Open the folder in Android Studio
  3. Update the namespace of your project
    • Go to the "lib > utils" folder and update the constants and styles file accordingly
    • Optionally, create an env.dart file inside the "lib > utils" folder to store secret keys (this file will not be saved in git for privacy concerns)
  4. Rename the namespace to your appId:
    • Ensure Android Studio has finished indexing your project
    • Go to the starterkit_android folder in the Project Viewer mode
    • Right-click on space and select "Refactor > Rename" to rename it to your desired name (e.g., example)
    • Repeat the same steps for acelords and starterkit
    • Confirm the namespace changes in AppManifest and all build.gradle files
  5. Start building your app

Summary

The Flutter Starter Kit is a boilerplate application that follows the BLoC Pattern for efficient data fetching and posting. It provides a well-organized project structure with separate folders for managing APIs, blocs, models, repositories, responses, utilities, views, and partials. It also includes features like centralized color/branding management, Google AdMob integration, Firebase FCM integration, and sample pages. The installation process involves cloning the repository, updating namespaces, and configuring constants and styles.

Flutter

Flutter is an open-source UI framework developed by Google that allows developers to create high-performance, cross-platform mobile applications with a single codebase.