Get started with Firestore Standard edition  |  Firebase

Web

1. Follow the instructions to add Firebase to your web app.
2. The Cloud Firestore SDK is available as an npm package.

   npm install firebase@12.10.0 --save

   You'll need to import both Firebase and Cloud Firestore.

   import { initializeApp } from "firebase/app";
   import { getFirestore } from "firebase/firestore";

Web

1. Follow the instructions to add Firebase to your web app.
2. Add the Firebase and Cloud Firestore libraries to your app:

   <script src="https://www.gstatic.com/firebasejs/12.10.0/firebase-app-compat.js"></script>
   <script src="https://www.gstatic.com/firebasejs/12.10.0/firebase-firestore-compat.js"></script>

   The Cloud Firestore SDK is also available as an npm package.

   npm install firebase@12.10.0 --save

   You'll need to manually require both Firebase and Cloud Firestore.

   import firebase from "firebase/compat/app";
   // Required for side-effects
   import "firebase/firestore";

iOS+

Follow the instructions to add Firebase to your Apple app.

Use Swift Package Manager to install and manage Firebase dependencies.

1. In Xcode, with your app project open, navigate to File > Swift Packages > Add Package Dependency.
2. When prompted, add the Firebase Apple platforms SDK repository:

  https://github.com/firebase/firebase-ios-sdk
  

3. Choose the Firestore library.
4. When finished, Xcode will automatically begin resolving and downloading your dependencies in the background.

Android

1. Follow the instructions to add Firebase to your Android app.
2. Using the Firebase Android BoM, declare the dependency for the Cloud Firestore library for Android in your module (app-level) Gradle file (usually app/build.gradle.kts or app/build.gradle).

   dependencies {
       // Import the BoM for the Firebase platform
       implementation(platform("com.google.firebase:firebase-bom:34.10.0"))
   
       // Declare the dependency for the Cloud Firestore library
       // When using the BoM, you don't specify versions in Firebase library dependencies
       implementation("com.google.firebase:firebase-firestore")
   }

   By using the Firebase Android BoM, your app will always use compatible versions of the Firebase Android libraries.

   (Alternative) Declare Firebase library dependencies without using the BoM

   If you choose not to use the Firebase BoM, you must specify each Firebase library version in its dependency line.

   Note that if you use multiple Firebase libraries in your app, we highly recommend using the BoM to manage library versions, which ensures that all versions are compatible.

   dependencies {
       // Declare the dependency for the Cloud Firestore library
       // When NOT using the BoM, you must specify versions in Firebase library dependencies
       implementation("com.google.firebase:firebase-firestore:26.1.1")
   }

   Looking for a Kotlin-specific library module? Starting with the October 2023 release, both Kotlin and Java developers can depend on the main library module (for details, see the FAQ about this initiative).

Dart

1. If you haven't already, configure and initialize Firebase in your Flutter app.
2. From the root of your Flutter project, run the following command to install the plugin:

   flutter pub add cloud_firestore

3. Once complete, rebuild your Flutter application:

   flutter run

4. Optional: Improve iOS & macOS build times by including the pre-compiled framework.

   Currently, the Firestore SDK for iOS depends on code that can take upwards of 5 minutes to build in Xcode. To reduce build times significantly, you can use a pre-compiled version by adding this line to the target 'Runner' do block in your Podfile:

   target 'Runner' do
     use_frameworks!
     use_modular_headers!
   
     pod 'FirebaseFirestore',
       :git => 'https://github.com/invertase/firestore-ios-sdk-frameworks.git',
       :tag => 'IOS_SDK_VERSION'
   
     flutter_install_all_ios_pods File.dirname(File.realpath(__FILE__))
     target 'RunnerTests' do
       inherit! :search_paths
     end
   end

   Replace IOS_SDK_VERSION with the version of the Firebase iOS SDK specified in firebase_core's firebase_sdk_version.rb file. If you're not using the latest version of firebase_core, look for this file in your local Pub package cache (usually ~/.pub-cache).

   Additionally, ensure that you have upgraded CocoaPods to 1.9.1 or higher:

   gem install cocoapods

   For more information see the issue on GitHub.

C++

1. Follow the instructions to add Firebase to your C++ project.
2. C++ interface for Android.
• Gradle dependencies. Add the following to your module (app-level) Gradle file (usually app/build.gradle):

          android.defaultConfig.externalNativeBuild.cmake {
            arguments "-DFIREBASE_CPP_SDK_DIR=$gradle.firebase_cpp_sdk_dir"
          }
  
          apply from: "$gradle.firebase_cpp_sdk_dir/Android/firebase_dependencies.gradle"
          firebaseCpp.dependencies {
            // earlier entries
            auth
            firestore
          }
          

• Binary dependencies. Similarly, the recommended way to get the binary dependencies is to add the following to your CMakeLists.txt file:

          add_subdirectory(${FIREBASE_CPP_SDK_DIR} bin/ EXCLUDE_FROM_ALL)
          set(firebase_libs firebase_auth firebase_firestore firebase_app)
          # Replace the target name below with the actual name of your target,
          # for example, "native-lib".
          target_link_libraries(${YOUR_TARGET_NAME_HERE} "${firebase_libs}")
          

3. To set up desktop integration, see Add Firebase to your C++ project.

Unity

1. Follow the instructions to add Firebase to your Unity project.
2. Use the Unity interface to configure your project to minify Android builds.

You must minify the build to avoid the message Error while merging dex archives.

• The option can be found in Player Settings > Android > Publishing Settings > Minify.
• The options may differ in different versions of Unity so refer to the official Unity documentation and the Firebase Unity Build Debug Guide.
• If, after enabling minification, the number of referenced methods still exceeds the limit, another option is to enable multidex in:
  • mainTemplate.gradle if Custom Gradle Template under Player Settings is enabled
  • or, the module-level build.gradle file, if you use Android Studio to build the exported project.

Web

import { initializeApp } from "firebase/app";
import { getFirestore } from "firebase/firestore";

// TODO: Replace the following with your app's Firebase project configuration
// See: https://support.google.com/firebase/answer/7015592
const firebaseConfig = {
    FIREBASE_CONFIGURATION
};

// Initialize Firebase
const app = initializeApp(firebaseConfig);


// Initialize Cloud Firestore and get a reference to the service
const db = getFirestore(app);

Replace FIREBASE_CONFIGURATION with your web app's firebaseConfig.

To persist data when the device loses its connection, see the Enable Offline Data documentation.

Web

import firebase from "firebase/app";
import "firebase/firestore";

// TODO: Replace the following with your app's Firebase project configuration
// See: https://support.google.com/firebase/answer/7015592
const firebaseConfig = {
    FIREBASE_CONFIGURATION
};

// Initialize Firebase
firebase.initializeApp(firebaseConfig);


// Initialize Cloud Firestore and get a reference to the service
const db = firebase.firestore();

Replace FIREBASE_CONFIGURATION with your web app's firebaseConfig.

To persist data when the device loses its connection, see the Enable Offline Data documentation.

Swift

Note: This product is not available on watchOS and App Clip targets.

import FirebaseCore
import FirebaseFirestore

FirebaseApp.configure()

let db = Firestore.firestore()

Objective-C

Note: This product is not available on watchOS and App Clip targets.

@import FirebaseCore;
@import FirebaseFirestore;

// Use Firebase library to configure APIs
[FIRApp configure];
  

FIRFirestore *defaultFirestore = [FIRFirestore firestore];

Kotlin

// Access a Cloud Firestore instance from your Activity

val db = Firebase.firestore.kt