iOS/Pods/FirebaseCore/README.md

   1 # Firebase iOS Open Source Development [![Build Status](https://travis-ci.org/firebase/firebase-ios-sdk.svg?branch=master)](https://travis-ci.org/firebase/firebase-ios-sdk)
   2
   3 This repository contains a subset of the Firebase iOS SDK source. It currently
   4 includes FirebaseCore, FirebaseAuth, FirebaseDatabase, FirebaseFirestore,
   5 FirebaseFunctions, FirebaseInAppMessagingDisplay, FirebaseMessaging and
   6 FirebaseStorage.
   7
   8 The repository also includes GoogleUtilities source. The
   9 [GoogleUtilities](GoogleUtilities/README.md) pod is
  10 a set of utilities used by Firebase and other Google products.
  11
  12 Firebase is an app development platform with tools to help you build, grow and
  13 monetize your app. More information about Firebase can be found at
  14 [https://firebase.google.com](https://firebase.google.com).
  15
  16 ## Installation
  17
  18 See the three subsections for details about three different installation methods.
  19 1. [Standard pod install](README.md#standard-pod-install)
  20 1. [Installing from the GitHub repo](README.md#installing-from-github)
  21 1. [Experimental Carthage](README.md#carthage-ios-only)
  22
  23 ### Standard pod install
  24
  25 Go to
  26 [https://firebase.google.com/docs/ios/setup](https://firebase.google.com/docs/ios/setup).
  27
  28 ### Installing from GitHub
  29
  30 For releases starting with 5.0.0, the source for each release is also deployed
  31 to CocoaPods master and available via standard
  32 [CocoaPods Podfile syntax](https://guides.cocoapods.org/syntax/podfile.html#pod).
  33
  34 These instructions can be used to access the Firebase repo at other branches,
  35 tags, or commits.
  36
  37 #### Background
  38
  39 See
  40 [the Podfile Syntax Reference](https://guides.cocoapods.org/syntax/podfile.html#pod)
  41 for instructions and options about overriding pod source locations.
  42
  43 #### Accessing Firebase Source Snapshots
  44
  45 All of the official releases are tagged in this repo and available via CocoaPods. To access a local
  46 source snapshot or unreleased branch, use Podfile directives like the following:
  47
  48 To access FirebaseFirestore via a branch:
  49 ```
  50 pod 'FirebaseCore', :git => 'https://github.com/firebase/firebase-ios-sdk.git', :branch => 'master'
  51 pod 'FirebaseFirestore', :git => 'https://github.com/firebase/firebase-ios-sdk.git', :branch => 'master'
  52 ```
  53
  54 To access FirebaseMessaging via a checked out version of the firebase-ios-sdk repo do:
  55
  56 ```
  57 pod 'FirebaseCore', :path => '/path/to/firebase-ios-sdk'
  58 pod 'FirebaseMessaging', :path => '/path/to/firebase-ios-sdk'
  59 ```
  60
  61 ### Carthage (iOS only)
  62
  63 An experimental Carthage distribution is now available. See
  64 [Carthage](Carthage.md).
  65
  66 ## Development
  67
  68 Follow the subsequent instructions to develop, debug, unit test, run integration
  69 tests, and try out reference samples:
  70
  71 ```
  72 $ git clone git@github.com:firebase/firebase-ios-sdk.git
  73 $ cd firebase-ios-sdk/Example
  74 $ pod update
  75 $ open Firebase.xcworkspace
  76 ```
  77
  78 Firestore and Functions have self contained Xcode projects. See
  79 [Firestore/README.md](Firestore/README.md) and
  80 [Functions/README.md](Functions/README.md).
  81
  82 ### Running Unit Tests
  83
  84 Select a scheme and press Command-u to build a component and run its unit tests.
  85
  86 ### Running Sample Apps
  87 In order to run the sample apps and integration tests, you'll need valid
  88 `GoogleService-Info.plist` files for those samples. The Firebase Xcode project contains dummy plist
  89 files without real values, but can be replaced with real plist files. To get your own
  90 `GoogleService-Info.plist` files:
  91
  92 1. Go to the [Firebase Console](https://console.firebase.google.com/)
  93 2. Create a new Firebase project, if you don't already have one
  94 3. For each sample app you want to test, create a new Firebase app with the sample app's bundle
  95 identifier (e.g. `com.google.Database-Example`)
  96 4. Download the resulting `GoogleService-Info.plist` and replace the appropriate dummy plist file
  97 (e.g. in [Example/Database/App/](Example/Database/App/));
  98
  99 Some sample apps like Firebase Messaging ([Example/Messaging/App](Example/Messaging/App)) require
 100 special Apple capabilities, and you will have to change the sample app to use a unique bundle
 101 identifier that you can control in your own Apple Developer account.
 102
 103 ## Specific Component Instructions
 104 See the sections below for any special instructions for those components.
 105
 106 ### Firebase Auth
 107
 108 If you're doing specific Firebase Auth development, see
 109 [the Auth Sample README](Example/Auth/README.md) for instructions about
 110 building and running the FirebaseAuth pod along with various samples and tests.
 111
 112 ### Firebase Database
 113
 114 To run the Database Integration tests, make your database authentication rules
 115 [public](https://firebase.google.com/docs/database/security/quickstart).
 116
 117 ### Firebase Storage
 118
 119 To run the Storage Integration tests, follow the instructions in
 120 [FIRStorageIntegrationTests.m](Example/Storage/Tests/Integration/FIRStorageIntegrationTests.m).
 121
 122 #### Push Notifications
 123
 124 Push notifications can only be delivered to specially provisioned App IDs in the developer portal.
 125 In order to actually test receiving push notifications, you will need to:
 126
 127 1. Change the bundle identifier of the sample app to something you own in your Apple Developer
 128 account, and enable that App ID for push notifications.
 129 2. You'll also need to
 130 [upload your APNs Provider Authentication Key or certificate to the Firebase Console](https://firebase.google.com/docs/cloud-messaging/ios/certs)
 131 at **Project Settings > Cloud Messaging > [Your Firebase App]**.
 132 3. Ensure your iOS device is added to your Apple Developer portal as a test device.
 133
 134 #### iOS Simulator
 135
 136 The iOS Simulator cannot register for remote notifications, and will not receive push notifications.
 137 In order to receive push notifications, you'll have to follow the steps above and run the app on a
 138 physical device.
 139
 140 ## Community Supported Efforts
 141
 142 We've seen an amazing amount of interest and contributions to improve the Firebase SDKs, and we are
 143 very grateful!  We'd like to empower as many developers as we can to be able to use Firebase and
 144 participate in the Firebase community.
 145
 146 ### macOS and tvOS
 147 FirebaseAuth, FirebaseCore, FirebaseDatabase and FirebaseStorage now compile, run unit tests, and
 148 work on macOS and tvOS, thanks to contributions from the community. There are a few tweaks needed,
 149 like ensuring iOS-only, macOS-only, or tvOS-only code is correctly guarded with checks for
 150 `TARGET_OS_IOS`, `TARGET_OS_OSX` and `TARGET_OS_TV`.
 151
 152 For tvOS, checkout the [Sample](Example/tvOSSample).
 153
 154 Keep in mind that macOS and tvOS are not officially supported by Firebase, and this repository is
 155 actively developed primarily for iOS. While we can catch basic unit test issues with Travis, there
 156 may be some changes where the SDK no longer works as expected on macOS or tvOS. If you encounter
 157 this, please [file an issue](https://github.com/firebase/firebase-ios-sdk/issues).
 158
 159 For installation instructions, see [above](README.md#accessing-firebase-source-snapshots).
 160
 161 Note that the Firebase pod is not available for macOS and tvOS. Install a selection of the
 162 `FirebaseAuth`, `FirebaseCore`, `FirebaseDatabase` and `FirebaseStorage` CocoaPods.
 163
 164 ## Roadmap
 165
 166 See [Roadmap](ROADMAP.md) for more about the Firebase iOS SDK Open Source
 167 plans and directions.
 168
 169 ## Contributing
 170
 171 See [Contributing](CONTRIBUTING.md) for more information on contributing to the Firebase
 172 iOS SDK.
 173
 174 ## License
 175
 176 The contents of this repository is licensed under the
 177 [Apache License, version 2.0](http://www.apache.org/licenses/LICENSE-2.0).
 178
 179 Your use of Firebase is governed by the
 180 [Terms of Service for Firebase Services](https://firebase.google.com/terms/).