firebase_upgrader

Description:

firebase upgrader

firebase_upgrader #
A Flutter package for handling optional and forceful app updates using Firebase Reatime Database.
Table of Contents #

firebase_upgrader
Table of Contents

Installation
Usage

Simple Example
Customizable Example


Contributions and Issues



Installation #
Add firebase_upgrader to your pubspec.yaml file:
dependencies:
firebase_upgrader: ^1.0.3
copied to clipboard
Run flutter pub get to install the package.
Usage #
1- Add the following code to your main() function to ensure initialization:
void main() {
WidgetsFlutterBinding.ensureInitialized(); //Add this line
runApp(const MyApp());
}
copied to clipboard
2- Add the following properties to your MaterialApp widget:
navigatorKey: FirebaseUpgrader.navigationKey,
builder: FirebaseUpgrader.builder,
copied to clipboard
3- Specify the minimum version and current version of your app in the Firebase Realtime Database as follow:
{
"features": {
"minVersion": "1.23.45",
"currentVersion": "1.23.45",
"storeLink": "your.store.link",
}
}
copied to clipboard
You can also specify different version according to the platform as follow:
{
"features": {
"minVersion": {
"ios": "1.23.45",
"android": "1.23.45",
},
"currentVersion": {
"ios": "1.23.45",
"android": "1.23.45",
},
"storeLink": {
"ios": "your.store.link",
"android": "your.store.link",
}
}
}
copied to clipboard
Simple Example #
import 'package:firebase_upgrader/firebase_upgrader.dart';

void main() {
WidgetsFlutterBinding.ensureInitialized();
runApp(MyApp());
}

class MyApp extends StatelessWidget {
@override
Widget build(BuildContext context) {
return MaterialApp(
navigatorKey: FirebaseUpgrader.navigationKey,
builder: FirebaseUpgrader.builder,
// Other MaterialApp properties...
);
}
}
copied to clipboard
Customizable Example #
You can customize the appearance and behavior of the FirebaseUpgrader providing optional parameters to the FirebaseUpgrader as follow:
import 'package:flutter/material.dart';
import 'package:firebase_upgrader/firebase_upgrader.dart';

void main() {
WidgetsFlutterBinding.ensureInitialized();
runApp(MyApp());
}

class MyApp extends StatelessWidget {
@override
Widget build(BuildContext context) {
return MaterialApp(
navigatorKey: FirebaseUpgrader.navigationKey,
builder: (context, child){
return FirebaseUpgrader(
child: child,
optionalTitle: 'New Update Available',
optionalMessage: 'A new version is available. Do you want to update?',
optionalButtonText: 'Update Now',
forceTitle: 'Upgrade Required',
forceMessage: 'This version of the app is no longer supported. Please upgrade to the latest version.',
forceButtonText: 'Upgrade',
logo: Image.asset('assets/logo.png'), // Add your logo image asset
appStoreLink: 'https://apps.apple.com/us/app/your-app-name/id123456789', // Add your App Store link
playStoreLink: 'https://play.google.com/store/apps/details?id=com.example.app',
optionalUpgradeScreen: someWidegt,
forceUpgradeScreen: anotherWidget,
);
},
home: child: Scaffold(
appBar: AppBar(
title: Text('Customized Firebase Upgrader'),
),
body: Center(
child: Text('Welcome to the customized app!'),
),
),
);
}
}
copied to clipboard
Contributions and Issues #
Contributions and bug reports are welcome! Please feel free to open an issue or submit a pull request on the GitHub repository.