Skip to content

Latest commit

 

History

History
93 lines (80 loc) · 3.77 KB

Rome.md

File metadata and controls

93 lines (80 loc) · 3.77 KB
Raw

Firebase Rome

Context

This page introduces and provides instructions for using Firebase via a Rome distribution. Based on feedback and usage, the Firebase team may decide to make the Rome support official.

Please let us know if you have suggestions or questions.

Introduction

Unlike regular CocoaPods, Rome does not touch the Xcode project file. It installs and builds all of the frameworks and leaves the project integration to you.

As a result, with Rome, the installed frameworks are all binary whether the CocoaPod itself was source or binary.

In comparison to Carthage, Rome supports subspecs. Therefore, you can install exactly the right frameworks customized for your requirements.

Rome Installation

$ gem install cocoapods-rome

Firebase Installation

Prefix a Podfile with the following:

plugin 'cocoapods-rome',
    dsym: false,
    configuration: 'Release'

Then do the following steps:

  1. Delete any Firebase pods that you don't need
  2. Run pod install
  3. With the Finder open Rome
  4. Make sure you have an Xcode project open in Xcode.
  5. 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.
  6. Drag each framework from the Finder window into 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".
  7. Find the dynamic frameworks: In a shell type: file Rome/*/* | grep universal | grep dynamic
  8. Drag each dynamic framework to the "Embed Frameworks" section on the Xcode Build Target's "General" page.
  9. If you're using FirebaseML, FirebaseInAppMessaging, or FirebaseFirestore, find the resources to the project: ls -ld Pods/*/Resources/*. More details on this below.
  10. Drag all of those resources into the Project Navigator, just like the frameworks, again making sure that the target you want to add these resources to has a checkmark next to it, and that you've selected "Copy items if needed".
  11. 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" (without quotes)
  12. Add Firebase.h and module support: a. In your project settings, open the Settings panel for your target b. Go to the Build Settings tab and find the "User Header Search Paths" setting in the Search Paths section. c. Double-click the setting, click the '+' button, and add Pods/Firebase/CoreOnly/Sources
  13. Make sure that the build target(s) includes your project's GoogleService-Info.plist (how to download config file).
  14. You're done! Compile your target and start using Firebase.

Firebase Resource Details

  • If you're including a Firebase component that has resources, copy its bundles into the Xcode project and make sure they're added to the Copy Bundle Resources Build Phase :
    • For Firestore:
      • ./Rome/GRPCClient.framework/gRPCCertificates.bundle
    • For InAppMessagingDisplay:
      • ./Rome/FirebaseInAppMessagingDisplay.framework/InAppMessagingDisplayResources.bundle
    • For FirebaseMLVisionFaceModel:
      • ./Pods/GoogleMobileVision/FaceDetector/Resources/GoogleMVFaceDetectorResources
    • For FirebaseMLVisionTextModel:
      • ./Pods/GoogleMobileVision/TextDetector/Resources/GoogleMVTextDetectorResources
  • For the FirebaseML resources, a bundle needs to be created. TBD better instructions here.