Prerequisites
Install the following:
- Xcode 15.2 or later
Make sure that your project meets these requirements:
- Your project must target these platform versions or later:
- iOS 13
- macOS 10.15
- tvOS 13
- watchOS 7
- Your project must target these platform versions or later:
Set up a physical Apple device or use a simulator to run your app.
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.
- Sign into Firebase using your Google account.
If you don't already have an Xcode project and just want to try out a Firebase product, you can download one of our quickstart samples.
Step 1: Create a Firebase project
Before you can add Firebase to your Apple app, you need to create a Firebase project to connect to your app. Visit Understand Firebase Projects to learn more about Firebase projects.
Step 2: Register your app with Firebase
To use Firebase in your Apple app, you need to register your app with your Firebase project. Registering your app is often called "adding" your app to your project.
Go to the Firebase console.
In the center of the project overview page, click the iOS+ icon to launch the setup workflow.
If you've already added an app to your Firebase project, click Add app to display the platform options.
Enter your app's bundle ID in the bundle ID field.
A bundle ID uniquely identifies an application in Apple's ecosystem.
Find your bundle ID: open your project in Xcode, select the top-level app in the project navigator, then select the General tab.
The value of the Bundle Identifier field is the bundle ID (for example,
com.yourcompany.yourproject
).Be aware that the bundle ID value is case-sensitive, and it cannot be changed for this Firebase app after it's registered with your Firebase project.
(Optional) Enter other app information: App nickname and App Store ID.
App nickname: An internal, convenience identifier that is only visible to you in the Firebase console
App Store ID: Used by Firebase Dynamic Links to redirect users to your App Store page and by Google Analytics to import conversion events into Google Ads. If your app doesn't yet have an App Store ID, you can add the ID later in your Project settings.
Click Register app.
Step 3: Add a Firebase configuration file
Click Download GoogleService-Info.plist to obtain your Firebase Apple platforms config file (
GoogleService-Info.plist
).The Firebase config file contains unique, but non-secret identifiers for your project. To learn more about this config file, visit Understand Firebase Projects.
You can download your Firebase config file again at any time.
Make sure the config file name is not appended with additional characters, like
(2)
.
Move your config file into the root of your Xcode project. If prompted, select to add the config file to all targets.
If you have multiple bundle IDs in your project, you must associate each bundle
ID with a registered app in the Firebase console so that each app can have
its own GoogleService-Info.plist
file.
Step 4: Add Firebase SDKs to your app
Use Swift Package Manager to install and manage Firebase dependencies.
- In Xcode, with your app project open, navigate to File > Add Packages.
- When prompted, add the Firebase Apple platforms SDK repository:
- Select the SDK version that you want to use.
Choose the Firebase libraries you want to use.
If Google Analytics is enabled in your Firebase project, make sure to add
FirebaseAnalytics
. For Analytics without IDFA collection capability, addFirebaseAnalyticsWithoutAdId
instead.
https://github.com/firebase/firebase-ios-sdk
When finished, Xcode will automatically begin resolving and downloading your dependencies in the background.
Step 5: Initialize Firebase in your app
The final step is to add initialization code to your application. You may have already done this as part of adding Firebase to your app. If you're using a quickstart sample project, this has been done for you.
- Import the
FirebaseCore
module in yourUIApplicationDelegate
, as well as any other Firebase modules your app delegate uses. For example, to use Cloud Firestore and Authentication:SwiftUI
import SwiftUI import FirebaseCore import FirebaseFirestore import FirebaseAuth // ...
Swift
import FirebaseCore import FirebaseFirestore import FirebaseAuth // ...
Objective-C
@import FirebaseCore; @import FirebaseFirestore; @import FirebaseAuth; // ...
- Configure a
FirebaseApp
shared instance in your app delegate'sapplication(_:didFinishLaunchingWithOptions:)
method:SwiftUI
// Use Firebase library to configure APIs FirebaseApp.configure()
Swift
// Use Firebase library to configure APIs FirebaseApp.configure()
Objective-C
// Use Firebase library to configure APIs [FIRApp configure];
- If you're using SwiftUI, you must create an application delegate and attach it
to your
App
struct viaUIApplicationDelegateAdaptor
orNSApplicationDelegateAdaptor
. You must also disable app delegate swizzling. For more information, see the SwiftUI instructions.SwiftUI
@main struct YourApp: App { // register app delegate for Firebase setup @UIApplicationDelegateAdaptor(AppDelegate.self) var delegate var body: some Scene { WindowGroup { NavigationView { ContentView() } } } }
- If you've included the Firebase SDK for Google Analytics, you can run your app to send verification to the Firebase console that you've successfully installed Firebase.
That's it! You can skip ahead to the next steps.
If you're having trouble getting set up, though, visit the Apple platforms troubleshooting & FAQ.
Available libraries
This section lists the Firebase products supported for Apple platforms. Learn more about these Firebase Apple platform libraries:
Firebase Apple platforms SDK GitHub repo
Service or Product | Pods | SwiftPM Libraries | Google Analytics.">Add Analytics? |
---|---|---|---|
AdMob | pod 'Google-Mobile-Ads-SDK' |
N/A | |
Analytics | pod 'FirebaseAnalytics' |
FirebaseAnalytics |
|
App Check | pod 'FirebaseAppCheck' |
FirebaseAppCheck |
|
App Distribution | pod 'FirebaseAppDistribution' |
FirebaseAppDistribution |
|
Authentication | pod 'FirebaseAuth' |
FirebaseAuth |
|
Cloud Firestore | pod 'FirebaseFirestore' |
FirebaseFirestore |
|
Cloud Functions for Firebase Client SDK | pod 'FirebaseFunctions' |
FirebaseFunctions |
|
Cloud Messaging | pod 'FirebaseMessaging' |
FirebaseMessaging |
|
Cloud Storage | pod 'FirebaseStorage' |
FirebaseStorage |
|
Crashlytics | pod 'FirebaseCrashlytics' |
FirebaseCrashlytics |
|
Dynamic Links | pod 'FirebaseDynamicLinks' |
FirebaseDynamicLinks |
|
In-App Messaging | pod 'FirebaseInAppMessaging' |
FirebaseInAppMessaging |
(required) |
Firebase installations | pod 'FirebaseInstallations' |
FirebaseInstallations |
|
Firebase ML Custom Model APIs | pod 'FirebaseMLModelDownloader' |
FirebaseMLModelDownloader |
|
Performance Monitoring | pod 'FirebasePerformance' |
FirebasePerformance |
|
Realtime Database | pod 'FirebaseDatabase' |
FirebaseDatabase |
|
Remote Config | pod 'FirebaseRemoteConfig' |
FirebaseRemoteConfig |
|
Vertex AI in Firebase | pod 'FirebaseVertexAI' |
FirebaseVertexAI |
Integrate without using Swift Package Manager
If you don't want to use Swift Package Manager, you can still take advantage of the Firebase SDKs by using CocoaPods or by importing the frameworks directly.
CocoaPods
Learn more about CocoaPods integration in our guide.
Frameworks
In addition to supporting the iOS platform, the zip now includes .xcframework
files. For details, see the Firebase
Apple platforms SDK README on
GitHub
.
Download the framework SDK zip. This is a ~200MB file and might take some time to download.
Unzip the file, and then integrate the frameworks that you want to include in your app.
You can find integration instructions in either of the following places:
- In the Firebase iOS SDK GitHub repository.
- In the
README.md
file within the downloaded zip distribution.
For information regarding framework versions or dependencies, refer to the
METADATA.md
file within the downloaded zip distribution.Add the
-ObjC
linker flag in yourOther Linker Settings
in your target's build settings.
Next steps
Learn about Firebase:
Visit Understand Firebase Projects to learn more about Firebase projects and best practices for projects.
Explore sample Firebase apps.
Get hands-on experience with the Firebase iOS Codelab.
Explore the open source code in GitHub.
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.
Having trouble with Firebase and your Apple project? Visit the Apple platforms troubleshooting & FAQ.
Add Firebase services to your app:
Gain insights on user behavior with Analytics.
Set up user authentication with Authentication.
Store data, like user information, with Cloud Firestore or Realtime Database.
Store files, like photos and videos, with Cloud Storage.
Trigger backend code that runs in a secure environment with Cloud Functions.
Send notifications with Cloud Messaging.
Find out when and why your app is crashing with Crashlytics.