Add Firebase to your Flutter app

Prerequisites

Install your preferred editor or IDE.
Set up a physical Apple device or use a simulator to run your app.
Do you want to use Cloud Messaging?
For Cloud Messaging on Apple platforms, here are the prerequisites:
- Set up a physical Apple device.
- Obtain an Apple Push Notification Authentication Key for your Apple Developer account.
- Enable Push Notifications in Xcode under App > Capabilities.
Make sure that your Flutter app targets the following platform versions or later:
- iOS 13
- macOS 10.15
Install Flutter for your specific operating system, including the following:
- Flutter SDK
- Supporting libraries
- Platform-specific software and SDKs
Sign into Firebase using your Google account.

If you don't already have a Flutter app, you can complete the Get Started: Test Drive to create a new Flutter app using your preferred editor or IDE.

Step 1: Install the required command line tools

If you haven't already, install the Firebase CLI.
Log into Firebase using your Google account by running the following command:
```
firebase login
```
Install the FlutterFire CLI by running the following command from any directory:
```
dart pub global activate flutterfire_cli
```

Step 2: Configure your apps to use Firebase

Use the FlutterFire CLI to configure your Flutter apps to connect to Firebase.

From your Flutter project directory, run the following command to start the app configuration workflow:

flutterfire configure

What does this flutterfire configure workflow do?

The flutterfire configure workflow does the following:

Asks you to select the platforms (iOS, Android, Web) supported in your Flutter app. For each selected platform, the FlutterFire CLI creates a new Firebase app in your Firebase project.

You can select either to use an existing Firebase project or to create a new Firebase project. If you already have apps registered in an existing Firebase project, the FlutterFire CLI will attempt to match them based on your current Flutter project configuration.

Note: Here are some tips about setting up and managing your Firebase project:

Check out our best practices for adding apps to a Firebase project, including how to handle multiple variants.

Enable Google Analytics in your project, which enables you to have an optimal experience using many Firebase products, like Crashlytics and Remote Config.

Creates a Firebase configuration file (firebase_options.dart) and adds it to your lib/ directory.

Note: This Firebase config file contains unique, but non-secret identifiers for each platform you selected.
Visit Understand Firebase Projects to learn more about this config file.

(for Crashlytics or Performance Monitoring on Android) Adds the required product-specific Gradle plugins to your Flutter app.

Note: For the FlutterFire CLI to add the appropriate Gradle plugin, the product's Flutter plugin must already be imported into your Flutter app.

After this initial running of flutterfire configure, you need to re-run the command any time that you:

Start supporting a new platform in your Flutter app.
Start using a new Firebase service or product in your Flutter app, especially if you start using sign-in with Google, Crashlytics, Performance Monitoring, or Realtime Database.

Re-running the command ensures that your Flutter app's Firebase configuration is up-to-date and (for Android) automatically adds any required Gradle plugins to your app.

Step 3: Initialize Firebase in your app

From your Flutter project directory, run the following command to install the core plugin:
```
flutter pub add firebase_core
```
From your Flutter project directory, run the following command to ensure that your Flutter app's Firebase configuration is up-to-date:
```
flutterfire configure
```
In your lib/main.dart file, import the Firebase core plugin and the configuration file you generated earlier:
```
import 'package:firebase_core/firebase_core.dart';
import 'firebase_options.dart';
```

Also in your lib/main.dart file, initialize Firebase using the DefaultFirebaseOptions object exported by the configuration file:

WidgetsFlutterBinding.ensureInitialized();
await Firebase.initializeApp(
  options: DefaultFirebaseOptions.currentPlatform,
);
runApp(const MyApp());

Rebuild your Flutter application:
```
flutter run
```

If you would rather use a demo project, you can start the Firebase Emulator and in your lib/main.dart file initialize Firebase using demoProjectId (it should start with demo-):

  await Firebase.initializeApp(
    demoProjectId: "demo-project-id",
  );

Step 4: Add Firebase plugins

You access Firebase in your Flutter app through the various Firebase Flutter plugins, one for each Firebase product (for example: Cloud Firestore, Authentication, Analytics, etc.).

Since Flutter is a multi-platform framework, each Firebase plugin is applicable for Apple, Android, and web platforms. So, if you add any Firebase plugin to your Flutter app, it will be used by the Apple, Android, and web versions of your app.

Here's how to add a Firebase Flutter plugin:

From your Flutter project directory, run the following command:
```
flutter pub add PLUGIN_NAME
```
From your Flutter project directory, run the following command:
```
flutterfire configure
```
Running this command ensures that your Flutter app's Firebase configuration is up-to-date and, for Crashlytics and Performance Monitoring on Android, adds the required Gradle plugins to your app.
Once complete, rebuild your Flutter project:
```
flutter run
```

You're all set! Your Flutter apps are registered and configured to use Firebase.

Available plugins

Product	Plugin name	Other Apple (macOS, etc.)	Windows
Analytics	`firebase_analytics`	beta
App Check	`firebase_app_check`	beta
Authentication	`firebase_auth`	beta	beta
Cloud Firestore	`cloud_firestore`	beta	beta
Cloud Functions	`cloud_functions`	beta
Cloud Messaging	`firebase_messaging`	beta
Cloud Storage	`firebase_storage`	beta	beta
Crashlytics	`firebase_crashlytics`	beta
Data Connect	`firebase_data_connect`
Dynamic Links	`firebase_dynamic_links`
In-App Messaging	`firebase_in_app_messaging`
Firebase installations	`firebase_app_installations`	beta
ML Model Downloader	`firebase_ml_model_downloader`	beta
Performance Monitoring	`firebase_performance`
Realtime Database	`firebase_database`	beta
Remote Config	`firebase_remote_config`	beta
Vertex AI in Firebase	`firebase_vertexai`	beta

Try out an example app with Analytics

Like all packages, the firebase_analytics plugin comes with an example program.

Open a Flutter app that you've already configured to use Firebase (see instructions on this page).
Access the lib directory of the app, then delete the existing main.dart file.
From the Google Analytics example program repository, copy-paste the following two files into your app's lib directory:
- main.dart
- tabs_page.dart
Run your Flutter app.
Go to your app's Firebase project in the Firebase console, then click Analytics in the left-nav.
1. Click Dashboard. If Analytics is working properly, the dashboard shows an active user in the "Users active in the last 30 minutes" panel (this might take time to populate this panel).
2. Click DebugView. Enable the feature to see all the events generated by the example program.

For more information about setting up Analytics, visit the getting started guides for iOS+, Android, and web.

Next steps

Get hands-on experience with the Firebase Flutter Codelab.
Prepare to launch your app:
- Set up budget alerts for your project in the Google Cloud console.
- Monitor the Usage and billing dashboard in the Firebase console to get an overall picture of your project's usage across multiple Firebase services.
- Review the Firebase launch checklist.