Objective-C C++ Objective-C++ C Swift Ruby Other
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.github Add Firestore to issue template (#332) Oct 4, 2017
Example Fix Auth_Tests_tvOS build config (#1717) Aug 20, 2018
Firebase update changelog for next release (#1710) Aug 17, 2018
Firestore Migrate FSTLevelDBMigrations to C++ LevelDbMigrations (#1714) Aug 20, 2018
Functions Reformat using 'clang-format version 7.0.0 (tags/google/stable/2018-0… Aug 13, 2018
GoogleUtilities Reformat using 'clang-format version 7.0.0 (tags/google/stable/2018-0… Aug 13, 2018
Interop/Auth/Public Add Auth interoperability library. (#1501) Jul 11, 2018
Releases add json Aug 8, 2018
cmake Fix benchmark builds on non-Apple platforms (#1677) Aug 13, 2018
scripts Make fuzzing run in the test stage (#1716) Aug 18, 2018
.clang-format Disallow merging short functions into a single line Aug 2, 2017
.gitignore Allow CMake to build Firestore with OpenSSL (#1597) Jul 27, 2018
.travis.yml Make fuzzing run in the test stage (#1716) Aug 18, 2018
CMAKE.md Rework the top-level cmake build to be a superproject (#538) Dec 7, 2017
CMakeLists.txt Add Google Benchmark to the CMake build (#1670) Aug 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 Mention additional libraries may be necessary for Carthage installs (#… Jul 23, 2018
FirebaseAuth.podspec Update versions for Release 5.5.0 Jul 26, 2018
FirebaseAuthInterop.podspec Update versions for Release 5.5.0 Jul 26, 2018
FirebaseCore.podspec Update versions for Release 5.6.0 Aug 8, 2018
FirebaseDatabase.podspec Update versions for Release 5.4.0 Jun 27, 2018
FirebaseFirestore.podspec Merge pull request #1695 from firebase/release-5.6.0 Aug 15, 2018
FirebaseFirestoreSwift.podspec Add build infrastructure for Codable support in Firestore (#815) Feb 26, 2018
FirebaseFunctions.podspec Update versions for Release 5.4.0 Jun 27, 2018
FirebaseMessaging.podspec Update versions for Release 5.5.0 Jul 26, 2018
FirebaseStorage.podspec community not experimental Apr 25, 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 Bump GoogleUtilities version to push extension fix (#1648) Aug 7, 2018
LICENSE Initial May 15, 2017
README.md Add GoogleUtilities README (#1541) Jul 16, 2018
ROADMAP.md Buildable and interoperable source pods (#444) Nov 22, 2017
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, 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)

An experimental Carthage distribution is now available. See Carthage.

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.

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 AuthSamples/README.md 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.