Skip to content

Latest commit

 

History

History
111 lines (84 loc) · 5.21 KB

README.md

File metadata and controls

111 lines (84 loc) · 5.21 KB
Raw

Firebase Apple SDKs

This directory contains the full Firebase Apple distribution, packaged as static xcframeworks that include support for the iOS, tvOS, macOS, watchOS and Catalyst platforms.

Tips for Integrating

  • It's recommended to remove your existing Firebase XCFramework installation before integrating a new version of XCFrameworks. This ensures that outdated files and directories from the existing installation do not break the code signature of the new installation.
  • If the integration is performed programmatically, ensure that the XCFrameworks are copied in a way that preserves symlinks (e.g. cp -rP, rsync -a).

Integration Instructions

Each Firebase component requires several xcframeworks in order to function properly. Each section below lists the xcframeworks you'll need to include in your project in order to use that Firebase SDK in your application.

Xcode 15.2 or newer is required.

To integrate a Firebase SDK with your app:

  1. Find the desired SDK from the list within METADATA.md.

  2. Make sure you have an Xcode project open in Xcode.

  3. In Xcode, hit ⌘-1 to open the Project Navigator pane. It will open on left side of the Xcode window if it wasn't already open.

  4. Remove any existing Firebase xcframeworks from your project.

  5. Drag each xcframework from the "FirebaseAnalytics" directory into the Project Navigator pane. In the dialog box that appears, make sure the target you want the framework to be added to has a checkmark next to it, and that you've selected "Copy items if needed".

    ⚠ To disable AdId support, do not copy GoogleAppMeasurementIdentitySupport.xcframework.

  6. Drag each framework from the directory named after the SDK into the Project Navigator pane. Note that there may be no additional frameworks, in which case this directory will be empty. For instance, if you want the Database SDK, look in the Database folder for the required frameworks. In the dialog box that appears, make sure the target you want this framework to be added to has a checkmark next to it, and that you've selected "Copy items if needed."

  7. If using Xcode 15, embed each framework that was dragged in. Navigate to the target's General settings and find Frameworks, Libraries, & Embedded Content. For each framework dragged in from the Firebase.zip, select Embed & Sign. This step will enable privacy manifests to be picked up by Xcode's tooling.

  8. Add the -ObjC flag to Other Linker Settings:

    a. In your project settings, open the Settings panel for your target.

    b. Go to the Build Settings tab and find the Other Linker Flags setting in the Linking section.

    c. Double-click the setting, click the '+' button, and add -ObjC

  9. Add the -lc++ flag to Other Linker Settings:

    a. In your project settings, open the Settings panel for your target.

    b. Go to the Build Settings tab and find the Other Linker Flags setting in the Linking section.

    c. Double-click the setting, click the '+' button, and add -lc++

  10. Drag the Firebase.h header in this directory into your project. This will allow you to #import "Firebase.h" and start using any Firebase SDK that you have.

  11. Drag module.modulemap into your project and update the "User Header Search Paths" in your project's Build Settings to include the directory that contains the added module map.

  12. If your app does not include any Swift implementation, you may need to add a dummy Swift file to the app to prevent Swift system library missing symbol linker errors. See https://forums.swift.org/t/using-binary-swift-sdks-from-non-swift-apps/55989.

⚠ If prompted with the option to create a corresponding bridging header for the new Swift file, select Don't create.

  1. You're done! Build your target and start using Firebase.

If you want to add another SDK, repeat the steps above with the xcframeworks for the new SDK. You only need to add each framework once, so if you've already added a framework for one SDK, you don't need to add it again. Note that some frameworks are required by multiple SDKs, and so appear in multiple folders.

The Firebase frameworks list the system libraries and frameworks they depend on in their modulemaps. If you have disabled the "Link Frameworks Automatically" option in your Xcode project/workspace, you will need to add the system frameworks and libraries listed in each Firebase framework's .framework/Modules/module.modulemap file to your target's or targets' "Link Binary With Libraries" build phase. Specifically, you may see the error ld: warning: Could not find or use auto-linked framework... which is an indicator that not all system libraries are being brought into your build automatically.

Samples

You can get samples for Firebase from https://github.com/firebase/quickstart-ios:

git clone https://github.com/firebase/quickstart-ios

Note that several of the samples depend on SDKs that are not included with this archive; for example, FirebaseUI. For the samples that depend on SDKs not included in this archive, you'll need to use CocoaPods or use the ZipBuilder to create your own custom binary frameworks.