iOS/Pods/Firebase/README.md

   1 # Firebase APIs for iOS
   2
   3 Simplify your iOS development, grow your user base, and monetize more
   4 effectively with Firebase services.
   5
   6 Much more information can be found at [https://firebase.google.com](https://firebase.google.com).
   7
   8 ## Install a Firebase SDK using CocoaPods
   9
  10 Firebase distributes several iOS specific APIs and SDKs via CocoaPods.
  11 You can install the CocoaPods tool on OS X by running the following command from
  12 the terminal. Detailed information is available in the [Getting Started
  13 guide](https://guides.cocoapods.org/using/getting-started.html#getting-started).
  14
  15 ```
  16 $ sudo gem install cocoapods
  17 ```
  18
  19 ## Try out an SDK
  20
  21 You can try any of the SDKs with `pod try`. Run the following command and select
  22 the SDK you are interested in when prompted:
  23
  24 ```
  25 $ pod try Firebase
  26 ```
  27
  28 Note that some SDKs may require credentials. More information is available in
  29 the SDK-specific documentation at [https://firebase.google.com/docs/](https://firebase.google.com/docs/).
  30
  31 ## Add a Firebase SDK to your iOS app
  32
  33 CocoaPods is used to install and manage dependencies in existing Xcode projects.
  34
  35 1.  Create an Xcode project, and save it to your local machine.
  36 2.  Create a file named `Podfile` in your project directory. This file defines
  37     your project's dependencies, and is commonly referred to as a Podspec.
  38 3.  Open `Podfile`, and add your dependencies. A simple Podspec is shown here:
  39
  40     ```
  41     platform :ios, '8.0'
  42     pod 'Firebase'
  43     ```
  44
  45 4.  Save the file.
  46
  47 5.  Open a terminal and `cd` to the directory containing the Podfile.
  48
  49     ```
  50     $ cd <path-to-project>/project/
  51     ```
  52
  53 6.  Run the `pod install` command. This will install the SDKs specified in the
  54     Podspec, along with any dependencies they may have.
  55
  56     ```
  57     $ pod install
  58     ```
  59
  60 7.  Open your app's `.xcworkspace` file to launch Xcode. Use this file for all
  61     development on your app.
  62
  63 8.  You can also install other Firebase SDKs by adding the subspecs in the
  64     Podfile.
  65
  66     ```
  67     pod 'Firebase/AdMob'
  68     pod 'Firebase/Analytics'
  69     pod 'Firebase/Auth'
  70     pod 'Firebase/Crash'
  71     pod 'Firebase/Database'
  72     pod 'Firebase/DynamicLinks'
  73     pod 'Firebase/Firestore'
  74     pod 'Firebase/Functions'
  75     pod 'Firebase/Invites'
  76     pod 'Firebase/Messaging'
  77     pod 'Firebase/MLCommon'
  78     pod 'Firebase/MLModelInterpreter'
  79     pod 'Firebase/MLVision'
  80     pod 'Firebase/MLVisionBarcodeModel'
  81     pod 'Firebase/MLVisionFaceModel'
  82     pod 'Firebase/MLVisionLabelModel'
  83     pod 'Firebase/MLVisionTextModel'
  84     pod 'Firebase/Performance'
  85     pod 'Firebase/RemoteConfig'
  86     pod 'Firebase/Storage'
  87     ```