Skip to content

Latest commit

 

History

History
339 lines (253 loc) · 14.9 KB

README.md

File metadata and controls

339 lines (253 loc) · 14.9 KB
Raw

Version License Platform

Actions Status Actions Status Actions Status Actions Status Actions Status Actions Status Actions Status Actions Status Actions Status Actions Status Actions Status Actions Status Actions Status Actions Status Actions Status Actions Status Actions Status Actions Status Actions Status Actions Status Actions Status Actions Status Actions Status Actions Status Travis

Firebase Apple Open Source Development

This repository contains all Apple platform Firebase SDK source except FirebaseAnalytics and FirebaseML.

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.

The repository also includes GoogleUtilities and GoogleDataTransport source which are utilities used by Firebase and other Google products.

Installation

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

  1. Standard pod install
  2. Swift Package Manager (Beta)
  3. Installing from the GitHub repo
  4. Experimental Carthage

Standard pod install

Go to https://firebase.google.com/docs/ios/setup. If you have a new Mac with an Apple silicon chip, please see these instructions.

Swift Package Manager (Beta)

Instructions for the Beta of Swift Package Manager support can be found at SwiftPackageManager.md.

Installing from GitHub

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. If you have a new Mac with an Apple silicon chip, please see these instructions.

Using Firebase from a Framework or a library

Using Firebase from a Framework or a library

Development

To develop Firebase software in this repository, ensure that you have at least the following software:

  • Xcode 12.0 (or later)

CocoaPods is still the canonical way to develop, but much of the repo now supports development with Swift Package Manager.

CocoaPods

Install

For the pod that you want to develop:

pod gen Firebase{name here}.podspec --local-sources=./ --auto-open --platforms=ios

Note: If the CocoaPods cache is out of date, you may need to run pod repo update before the pod gen command.

Note: Set the --platforms option to macos or tvos to develop/test for those platforms. Since 10.2, Xcode does not properly handle multi-platform CocoaPods workspaces.

Firestore has a self contained Xcode project. See Firestore/README.md.

Development for Catalyst

  • pod gen {name here}.podspec --local-sources=./ --auto-open --platforms=ios
  • Check the Mac box in the App-iOS Build Settings
  • Sign the App in the Settings Signing & Capabilities tab
  • Click Pods in the Project Manager
  • Add Signing to the iOS host app and unit test targets
  • Select the Unit-unit scheme
  • Run it to build and test

Alternatively disable signing in each target:

  • Go to Build Settings tab
  • Click +
  • Select Add User-Defined Setting
  • Add CODE_SIGNING_REQUIRED setting with a value of NO

Swift Package Manager

  • open Package.swift or double click Package.swift in Finder.
  • Xcode will open the project
    • Choose a scheme for a library to build or test suite to run
    • Choose a target platform by selecting the run destination along with the scheme

Adding a New Firebase Pod

See AddNewPod.md.

Managing Headers and Imports

See HeadersImports.md.

Code Formatting

To ensure that the code is formatted consistently, run the script ./scripts/check.sh before creating a PR.

GitHub Actions will verify that any code changes are done in a style compliant way. Install clang-format and mint:

brew install clang-format@11
brew install mint

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 a valid GoogleService-Info.plist file. 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 add it to the Xcode project.

Coverage Report Generation

See scripts/code_coverage_report/README.md.

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

The Firebase Database Integration tests can be run against a locally running Database Emulator or against a production instance.

To run against a local emulator instance, invoke ./scripts/run_database_emulator.sh start before running the integration test.

To run against a production instance, provide a valid GoogleServices-Info.plist and copy it to FirebaseDatabase/Tests/Resources/GoogleService-Info.plist. Your Security Rule must be set to public while your tests are running.

Firebase Performance Monitoring

If you're doing specific Firebase Performance Monitoring development, see the Performance README for instructions about building the SDK and the Performance TestApp README for instructions about integrating Performance with the dev test App.

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.

tvOS, macOS, watchOS and Catalyst

Thanks to contributions from the community, many of Firebase SDKs now compile, run unit tests, and work on tvOS, macOS, watchOS and Catalyst.

For tvOS, see the Sample. For watchOS, currently only Messaging, Storage and Crashlytics (and their dependencies) have limited support. See the Independent Watch App Sample.

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

During app setup in the console, you may get to a step that mentions something like "Checking if the app has communicated with our servers". This relies on Analytics and will not work on macOS/tvOS/watchOS/Catalyst. It's safe to ignore the message and continue, the rest of the SDKs will work as expected.

To install, add a subset of the following to the Podfile:

pod 'Firebase/ABTesting'
pod 'Firebase/Auth'          # Limited watchOS support
pod 'Firebase/Crashlytics'
pod 'Firebase/Database'      # No watchOS support yet
pod 'Firebase/Firestore'     # No watchOS support yet
pod 'Firebase/Functions'     # No watchOS support yet
pod 'Firebase/Messaging'
pod 'Firebase/Performance'   # No macOS, tvOS, watchOS, and Catalyst support yet
pod 'Firebase/RemoteConfig'
pod 'Firebase/Storage'

Additional Catalyst Notes

  • FirebaseAuth and FirebaseMessaging require adding Keychain Sharing Capability to Build Settings.
  • FirebaseFirestore requires signing the gRPC Resource target.

Additional Crashlytics Notes

  • watchOS has limited support. Due to watchOS restrictions, mach exceptions and signal crashes are not recorded. (Crashes in SwiftUI are generated as mach exceptions, so will not be recorded)

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.