Skip to main content

MacOS Installation

Before using FlutterFire on MacOS, you must first connect to your Firebase project with your MacOS application.

Generating a Firebase project configuration file#

On the Firebase Console, add a new iOS app or select an existing iOS app for your Firebase project. The "iOS bundle ID" must match your local project bundle ID for your MacOS application. The bundle ID can be found within the "General" tab when opening macos/Runner.xcworkspace with Xcode.

Download the GoogleService-Info.plist file for the Firebase app.

Installing your Firebase configuration file#

Next you must add the file to the project using Xcode (adding manually via the filesystem won't link the file to the project). Using Xcode, open the project's macos/{projectName}.xcworkspace file. Right click Runner from the left-hand side project navigation within Xcode and select "Add files", as seen below:

Add files via Xcode

Select the GoogleService-Info.plist file you downloaded, and ensure the "Copy items if needed" checkbox is enabled:

Add files via Xcode

Enabling use of Firebase Emulator Suite#

The Firebase Emulator Suite uses un-encrypted networking connections in order to enable fast, uncomplicated setup. However macOS by default requires encrypted networking connections. If you would like to use any part of the Firebase Emulator Suite to emulate firebase services on your local machine during development, you must allow your macOS app to connect to local network services over insecure connections.

To allow insecure connections, we recommend adding the NSAllowsLocalNetworking key to the NSAppTransportSecurity dictionary in your application's plist file.

Specifically if your app is named 'MyApp', and are sharing your configuration between iOS and macOS you might add these keys in ios/MyApp/Info.plist:

<key>NSAppTransportSecurity</key>
<dict>
<key>NSAllowsLocalNetworking</key>
<true/>
</dict>

Initializing FlutterFire#

Once complete follow the instructions on Initializing FlutterFire.

macOS Supported Versions#

FlutterFire supports a macOS deployment target of 10.12 or higher, in line with the requirements of the underlying firebase-ios-sdk.