⚠️⚠️ STILL IN DEVELOPMENT ⚠️⚠️

🌟 Introduction

Having built Flutter apps for a significant time, I've realized the initial setup for new projects can be quite repetitive. Remembering the time when I hadn't published any apps under my name until 2023, and now having a few under my belt, I felt the need for a streamlined process. This starter kit is a culmination of those experiences, aiming to simplify the setup for common features and services.

My AppStore Account: https://apps.apple.com/developer/id1644583007

🚀 Features

1. Firebase Integration

• Authentication: Set up Firebase Auth with related blocs, just like how I always wanted a seamless guest login at the last page of onboarding (Anonymous sign-in in Firebase auth).

2. In-App Reviews

• A feature I felt was crucial, especially after a user makes a successful purchase. It's a gentle nudge for them to leave a review.

3. RevenueCat Integration

• Display offers from RevenueCat. I've seen some apps always showing the trial option even when you're not eligible. With this kit, only eligible users will see the trial, avoiding the disappointment of finding out you don't have a free trial on the native payment sheet.
• Restore purchases with ease, using a dedicated purchase service and bloc for common operations.

4. Paywall & Offers

• A simple paywall page setup, along with pages for discounted and one-time offers.

5. Version Management

• Using Remote Config to manage app version numbers was something I always did. Now, you can easily let users know when they launch the app or even force them to update if necessary.

6. Analytics & Crashlytics

• Integrated tools for tracking user behavior and handling app crashes, essentials for any app I built.

7. Notifications

• A straightforward setup to manage app notifications.

8. Go Router

• Efficiently manage app navigation. For instance, redirecting users based on whether they've seen the onboarding, completed a purchase, or are already logged in.

9. Feature Usage Restrictions

• Implement local counters to track feature usage. For example, in one of my apps, non-premium users could analyze only 3 dreams a week, while premium users could engage in 100 chats a day. With Remote Config, setting and resetting these limits is a breeze.

📈 Future Plans

I'm on a journey to enhance this starter kit continuously. If you've walked a path similar to mine and have suggestions or encounter any issues, please feel free to contribute or raise them in the issues section.

Template depends on some services like Firebase and RevenueCat heavily. One of the future plans are making those optional and ask during mason make. Based on user choices, some packages and services won't be added.

I don't think I'll add those toggles anytime soon because as an indie developer, Firebase services and RevenueCat does the job for me.

🛠️ How to use

Installation

First, you need to install the Mason CLI. You can do this by activating it from pub.dev:

dart pub global activate mason_cli

Initialization

Once mason_cli is installed, you can initialize mason in the current directory. This will generate a mason.yaml and allow mason to work with bricks scoped locally within the workspace:

mason init

Installing Bricks

Now, you can install bricks. For example, to install the "hello" brick, uncomment the "hello" brick (hello: 0.1.0+1) in your mason.yaml:

bricks:
  bluemonday_brick:
    git:
      url: https://github.com/mirkancal/bluemonday_brick.git

Then, use the get command to install all bricks defined in the nearest parent mason.yaml:

mason get

Using the Brick

To use the brick, you can use the mason make command followed by the name of the brick. For example:

mason make bluemonday_brick

After installation

Since the project is depending on other services heavily, you need to set them up.

Firebase

The project includes Firebase services such as Auth, Notifications, Remote Config, Analytics, and Crashlytics. Setting up Firebase is essential. The Cloud Firestore package is added to both pubspec.yaml and Podfile. However, there's no initial code related to Firestore. If you decide to remove Firestore, ensure you remove it from both files.

I've provided a script named setup_firebase.sh that utilizes flutterfire to set up Firebase. Additionally, the app has three different flavors: production, development, and staging. If you need to add Firebase to other flavors, you can modify the script and execute it two more times.

RevenueCat

The template contains a PurchaseBloc and PurchaseService that utilize RevenueCat. For proper usage, you must set up products and register them on RevenueCat. Then, add your RevenueCat iOS and Android keys to the .env file. After completing these steps, execute the build_runner. The template also defines several scripts in pubspec.yaml. If you have the rps package installed, you can run commands like: rps clean ios.

Tree 🌲

.
├── README.md
├── analysis_options.yaml
├── android
├── build
├── ios
├── l10n.yaml
├── lib
│   ├── app
│   │   ├── app.dart
│   │   ├── utils
│   │   └── view
│   ├── auth
│   │   ├── bloc
│   │   ├── models
│   │   └── repository
│   ├── bootstrap.dart
│   ├── env
│   ├── firebase
│   ├── home
│   ├── injectable.config.dart
│   ├── injectable.dart
│   ├── l10n
│   ├── login
│   ├── main_development.dart
│   ├── main_production.dart
│   ├── main_staging.dart
│   ├── onboarding
│   ├── router
│   └── theme
├── project_structure.txt
└── prompts
    ├── commentor.md
    └── instructor.md
└── pubspec.yaml