Firebase iOS SDK
Switch branches/tags
API_Tests InAppMessagingDisplay-0.12.0 abseil-mirror add-5.6-json bs-clangver bs-funcauth bstpierr-patch-1 changelog_23 cpp/field_path cpp/port_dockey_three cpp/port_mutation_result fcm-pubsub fcm-test-error fcm-tests fcm fiam-fix-modal-tablet-orientation fix_api_tests gc_explore googledatalogger grpc-master gsoltis/include_sequence_number gsoltis/lru_tweaks gsoltis/reference_delegate ldb_lru log_fs_version log_pending_writes lru master md-fdl md-fdl2 md-undocustomdomainrevert minafarid/bugs-unit-tests minafarid/experimental minafarid/travis-fuzzing-10mins mph-googledatalogger mrschmidt-multitab mrschmidt-numericadd mrschmidt-numericproto mrschmidt-tombstones mylyuic/add-changelog-for-fiam-display mylyuic/add-fiam-display-component mylyuic/changelog-for-fiam-display mylyuic/fiam-display-version-tune nanopb-master nanopb_e1b pb-auth-tv-tests pb-codable pb-dl-os pb-firebase-module-to-core pb-firestore-static pb-func-testspecs pb-merge501 pb-podspec-mirror pb-style-functions pb-test-cp16 pb-tv-auth pb-unify-test-app percentile release-4.0.0 release-4.0.1 release-4.0.2 release-4.0.3 release-4.0.4 release-4.1.0 release-4.1.1 release-4.2.0 release-4.3.0 release-4.4.0 release-4.5.0 release-4.6.0 release-4.7.0 release-4.8.0 release-4.8.1 release-4.9.0 release-4.10.0 release-4.10.1 release-4.11.0 release-4.12.0 release-4.13.0 release-5.0.0 release-5.0.1 release-5.1.0 release-5.2.0 release-5.3.0 release-5.4.0 release-5.4.1 release-5.5.0 release-5.6.0 release-5.7.0 release-5.8.0 release-5.9.0 release-5.10.0 release-5.11.0 release-5.12.0 release-5.13.0 release-5.14.0 release-5.15.0 remove_remarks_from_deprecated_api remove_reverse_iteration rsgowman/cpp_mutations rsgowman/field_mask_set rsgowman/firestore-api-changes rsgowman/merge_master rsgowman/move_remaining_encode_methods rsgowman/nanopb_e rsgowman/nanopb_e1 rsgowman/nanopb_protos rsgowman/port_auth_suggestion rsgowman/serialize_missing rsgowman/serialize_mutation_batch rsgowman/serialize_txn rsgowman/simplify_serializers rsgowman/unknown_document rw-log-count-fix rw-today-extension rw-xcode10 samtstern-patch-1 samtstern-patch-2 staging-4.13.1 swizzler-master tdeshpande/open-source-swizzler tejasd/fix-extensions tejasd/fix-swizzler-analysis-errors travis-update tvOS_master updates_change_log varconst/async-queue-cpp varconst/async-queue-ios-take2 varconst/async-queue-ios=shared-ptr varconst/async-queue-ios varconst/async-queue-mm-libdispatch varconst/async-queue-more-tests varconst/async-queue-more-tests2 varconst/async-queue-port-user-queue varconst/async-queue-port-worker-queue varconst/async-queue-quick-deflake2 varconst/async-queue-refactored-delegate varconst/async-queue-refactored varconst/changelog varconst/cmake-no-xcpretty varconst/coll-opt-fragment varconst/coll-opt varconst/eliminate-fst-maybe-document-dictionary varconst/executor-fix-deadlock varconst/fix-double-finish varconst/fix-executor-libdispatch varconst/fix-fuzzer-log-overflow varconst/fix-pending-string varconst/grpc-buffered-writer varconst/grpc-cmake varconst/grpc-connectivity-monitor-base varconst/grpc-connectivity-monitor-use varconst/grpc-connectivity-monitor varconst/grpc-datastore-calls-review varconst/grpc-datastore-calls varconst/grpc-datastore-commit varconst/grpc-datastore-lookup varconst/grpc-datastore varconst/grpc-firestore-stream varconst/grpc-fix-auth-outlives-datastore varconst/grpc-integr8 varconst/grpc-integr82 varconst/grpc-integration-tests-datastore varconst/grpc-master varconst/grpc-mock-datastore varconst/grpc-readd-bugfix varconst/grpc-readd-grpc-cmake varconst/grpc-refactor-1 varconst/grpc-stream-fast-start varconst/grpc-stream varconst/grpc-test-certificate varconst/grpc-unit-tests-domain varconst/grpc-unit-tests-wrappers varconst/grpc-watch-stream varconst/grpc-watch-write-streams varconst/grpc-write-stream2 varconst/grpc2 varconst/gul-logger-ignore-race varconst/less-verbose-fuzzing varconst/merge-grpc-master varconst/pin-grpc-version varconst/reduce-fuzz-time varconst/replace-fst-dispatch-queue varconst/sanitizers-travis varconst/separate-user-queue varconst/token-refresh varconst/write-batch-slow2 wilhuff/grpc-cpp wilhuff/macos zxu/fit-lint zxu/tenseconds
Nothing to show
Clone or download
gsoltis Remove start from persistence interface (#2173)
* Remove start from persistence interface, switch FSTLevelDB to use a factory method that returns Status
Latest commit 598bc55 Dec 14, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Add Firestore to issue template (#332) Oct 4, 2017
.opensource Remove bad trailing comma (#1737) Aug 23, 2018
Example Use registerLibrary for pods in Firebase workspace (#2137) Dec 13, 2018
Firebase Use registerLibrary for pods in Firebase workspace (#2137) Dec 13, 2018
Firestore Remove start from persistence interface (#2173) Dec 14, 2018
Functions Use registerLibrary for pods in Firebase workspace (#2137) Dec 13, 2018
GoogleUtilities Fix Swizzler test warnings (#2144) Dec 5, 2018
InAppMessagingDisplay Address travis timeout flakes (#2033) Nov 1, 2018
Interop Renamed SDKs to frameworks and products for accuracy. Oct 26, 2018
Releases Add a travis cron job for CocoaPod symbol collision testing (#2154) Dec 6, 2018
SymbolCollisionTest Add a travis cron job for CocoaPod symbol collision testing (#2154) Dec 6, 2018
cmake gRPC: replace Objective-C implementation with the new C++ implementat… Nov 13, 2018
scripts Use registerLibrary for pods in Firebase workspace (#2137) Dec 13, 2018
.clang-format Disallow merging short functions into a single line Aug 2, 2017
.gitignore Update CMake build instructions (#1730) Aug 23, 2018
.travis.yml Add a travis cron job for CocoaPod symbol collision testing (#2154) Dec 6, 2018
CMAKE.md Update CMake build instructions (#1730) Aug 23, 2018
CMakeLists.txt gRPC: replace Objective-C implementation with the new C++ implementat… Nov 13, 2018
CODE_OF_CONDUCT.md Add Code of Conduct from Google open source template (#861) Feb 28, 2018
CONTRIBUTING.md Initial May 15, 2017
Carthage.md Update the name of certificates bundle (#2171) Dec 10, 2018
FirebaseAnalyticsInterop.podspec Do Messaging's Analytics logging via Interop (#1902) Oct 9, 2018
FirebaseAuth.podspec Update versions for Release 5.14.0 (#2145) Dec 5, 2018
FirebaseAuthInterop.podspec Update versions for Release 5.5.0 Jul 26, 2018
FirebaseCore.podspec Update versions for Release 5.14.0 (#2145) Dec 5, 2018
FirebaseDatabase.podspec Update versions for Release 5.14.0 (#2145) Dec 5, 2018
FirebaseDynamicLinks.podspec Update versions for Release 5.14.0 (#2145) Dec 5, 2018
FirebaseFirestore.podspec Update versions for Release 5.14.0 (#2145) Dec 5, 2018
FirebaseFirestoreSwift.podspec Add build infrastructure for Codable support in Firestore (#815) Feb 26, 2018
FirebaseFunctions.podspec Use registerLibrary for pods in Firebase workspace (#2137) Dec 13, 2018
FirebaseInAppMessagingDisplay.podspec Release 5.13.0 (#2101) Nov 20, 2018
FirebaseMessaging.podspec Update versions for Release 5.14.0 (#2145) Dec 5, 2018
FirebaseStorage.podspec Release 5.12.0 (#2051) Nov 6, 2018
Gemfile update travis script (#136) Sep 10, 2017
Gemfile.lock Update Travis to use CocoaPods 1.5.3 (#1391) Jun 8, 2018
GoogleUtilities.podspec Fix GoogleUtilities nullability regressions (#2079) Nov 15, 2018
LICENSE Initial May 15, 2017
README.md Add clang-format installation instructions (#2057) Nov 7, 2018
ROADMAP.md Buildable and interoperable source pods (#444) Nov 22, 2017
Rome.md Fix Rome instructions (#2184) Dec 13, 2018
test.sh Factor out a universal build script (#884) Mar 7, 2018

README.md

Firebase iOS Open Source Development Build Status

This repository contains a subset of the Firebase iOS SDK source. It currently includes FirebaseCore, FirebaseAuth, FirebaseDatabase, FirebaseFirestore, FirebaseFunctions, FirebaseInAppMessagingDisplay, FirebaseMessaging and FirebaseStorage.

The repository also includes GoogleUtilities source. The GoogleUtilities pod is a set of utilities used by Firebase and other Google products.

Firebase is an app development platform with tools to help you build, grow and monetize your app. More information about Firebase can be found at https://firebase.google.com.

Installation

See the three subsections for details about three different installation methods.

  1. Standard pod install
  2. Installing from the GitHub repo
  3. Experimental Carthage

Standard pod install

Go to https://firebase.google.com/docs/ios/setup.

Installing from GitHub

For releases starting with 5.0.0, the source for each release is also deployed to CocoaPods master and available via standard CocoaPods Podfile syntax.

These instructions can be used to access the Firebase repo at other branches, tags, or commits.

Background

See the Podfile Syntax Reference for instructions and options about overriding pod source locations.

Accessing Firebase Source Snapshots

All of the official releases are tagged in this repo and available via CocoaPods. To access a local source snapshot or unreleased branch, use Podfile directives like the following:

To access FirebaseFirestore via a branch:

pod 'FirebaseCore', :git => 'https://github.com/firebase/firebase-ios-sdk.git', :branch => 'master'
pod 'FirebaseFirestore', :git => 'https://github.com/firebase/firebase-ios-sdk.git', :branch => 'master'

To access FirebaseMessaging via a checked out version of the firebase-ios-sdk repo do:

pod 'FirebaseCore', :path => '/path/to/firebase-ios-sdk'
pod 'FirebaseMessaging', :path => '/path/to/firebase-ios-sdk'

Carthage (iOS only)

Instructions for the experimental Carthage distribution are at Carthage.

Rome

Instructions for installing binary frameworks via Rome are at Rome.

Development

Follow the subsequent instructions to develop, debug, unit test, run integration tests, and try out reference samples:

$ git clone git@github.com:firebase/firebase-ios-sdk.git
$ cd firebase-ios-sdk/Example
$ pod update
$ open Firebase.xcworkspace

Firestore and Functions have self contained Xcode projects. See Firestore/README.md and Functions/README.md.

Code Formatting

Travis will verify that any code changes are done in a style compliant way. Install clang-format and swiftformat. This command will get the right clang-format version:

brew install https://raw.githubusercontent.com/Homebrew/homebrew-core/0743d748ba8b41eec074a0a787dc80219142c525/Formula/clang-format.rb

Running Unit Tests

Select a scheme and press Command-u to build a component and run its unit tests.

Running Sample Apps

In order to run the sample apps and integration tests, you'll need valid GoogleService-Info.plist files for those samples. The Firebase Xcode project contains dummy plist files without real values, but can be replaced with real plist files. To get your own GoogleService-Info.plist files:

  1. Go to the Firebase Console
  2. Create a new Firebase project, if you don't already have one
  3. For each sample app you want to test, create a new Firebase app with the sample app's bundle identifier (e.g. com.google.Database-Example)
  4. Download the resulting GoogleService-Info.plist and replace the appropriate dummy plist file (e.g. in Example/Database/App/);

Some sample apps like Firebase Messaging (Example/Messaging/App) require special Apple capabilities, and you will have to change the sample app to use a unique bundle identifier that you can control in your own Apple Developer account.

Specific Component Instructions

See the sections below for any special instructions for those components.

Firebase Auth

If you're doing specific Firebase Auth development, see the Auth Sample README for instructions about building and running the FirebaseAuth pod along with various samples and tests.

Firebase Database

To run the Database Integration tests, make your database authentication rules public.

Firebase Storage

To run the Storage Integration tests, follow the instructions in FIRStorageIntegrationTests.m.

Push Notifications

Push notifications can only be delivered to specially provisioned App IDs in the developer portal. In order to actually test receiving push notifications, you will need to:

  1. Change the bundle identifier of the sample app to something you own in your Apple Developer account, and enable that App ID for push notifications.
  2. You'll also need to upload your APNs Provider Authentication Key or certificate to the Firebase Console at Project Settings > Cloud Messaging > [Your Firebase App].
  3. Ensure your iOS device is added to your Apple Developer portal as a test device.

iOS Simulator

The iOS Simulator cannot register for remote notifications, and will not receive push notifications. In order to receive push notifications, you'll have to follow the steps above and run the app on a physical device.

Community Supported Efforts

We've seen an amazing amount of interest and contributions to improve the Firebase SDKs, and we are very grateful! We'd like to empower as many developers as we can to be able to use Firebase and participate in the Firebase community.

macOS and tvOS

FirebaseAuth, FirebaseCore, FirebaseDatabase and FirebaseStorage now compile, run unit tests, and work on macOS and tvOS, thanks to contributions from the community. There are a few tweaks needed, like ensuring iOS-only, macOS-only, or tvOS-only code is correctly guarded with checks for TARGET_OS_IOS, TARGET_OS_OSX and TARGET_OS_TV.

For tvOS, checkout the Sample.

Keep in mind that macOS and tvOS are not officially supported by Firebase, and this repository is actively developed primarily for iOS. While we can catch basic unit test issues with Travis, there may be some changes where the SDK no longer works as expected on macOS or tvOS. If you encounter this, please file an issue.

For installation instructions, see above.

Note that the Firebase pod is not available for macOS and tvOS. Install a selection of the FirebaseAuth, FirebaseCore, FirebaseDatabase and FirebaseStorage CocoaPods.

Roadmap

See Roadmap for more about the Firebase iOS SDK Open Source plans and directions.

Contributing

See Contributing for more information on contributing to the Firebase iOS SDK.

License

The contents of this repository is licensed under the Apache License, version 2.0.

Your use of Firebase is governed by the Terms of Service for Firebase Services.