firebase-ios-sdk/Firestore/README.md

Usage

• Install prerequisite software

• Set up a workspace via CocoaPods

  $ cd Firestore/Example
  $ pod update
  $ open Firestore.xcworkspace
  

• Select the Firestore_Tests_iOS scheme

• ⌘-u to build and run the unit tests

Improving the debugger experience

You can install a set of type formatters to improve the presentation of Firestore internals in LLDB and Xcode. Add the following to your ~/.lldbinit file:

command script import ~/path/to/firebase-ios-sdk/scripts/lldb/firestore.py

(substitute the location of your checkout of the firebase-ios-sdk.)

Running Integration Tests

• Set up a GoogleServices-Info.plist file in Firestore/Example/App.
• In Xcode select the Firestore_IntegrationTests_iOS scheme
• ⌘-u to build and run the integration tests

Running Integration Tests - using the Firestore Emulator

Note: this does not give full coverage, but is much faster than above. b/hotlists/1578399 tracks outstanding issues.

• Ensure that GoogleServices-Info.plist is back in its default state (git checkout Firestore/Example/App/GoogleServices-Info.plist).

• Install the Firebase CLI. Essentially:

  npm install -g firebase-tools
  

• Install the Firestore emulator. Essentially:

  firebase setup:emulators:firestore
  

• Run the emulator

  firebase serve --only firestore
  

• In Xcode select the Firestore_IntegrationTests_iOS scheme

• ⌘-u to build and run the integration tests

Building Protos

Typically you should not need to worrying about regenerating the C++ files from the .proto files. If you do, see instructions at Protos/README.md.