diff --git a/README.md b/README.md index 992f2a66b0d..b707f4040b4 100644 --- a/README.md +++ b/README.md @@ -87,6 +87,11 @@ If you don't have a suitable testing project already: * Download the resulting `google-services.json` file and put it in the root of your checkout. +For now, you have to disable security rule enforcement for the Realtime +Database, Cloud Firestore, and Cloud Storage in your test project (if running +the integration tests for any of those). Re-enable your security rules after +your test run. + #### Running Integration Tests Integration tests can be executed on the command line by running @@ -204,6 +209,9 @@ projects may be published as follows. publishProjectsToMavenLocal ``` +To generate the Maven dependency tree under `build/` instead, you can replace +`publishProjectsToMavenLocal` in the above command with `firebasePublish`. + ### Code Formatting Code in this repo is formatted with the google-java-format tool. You can enable diff --git a/firebase-database/README.md b/firebase-database/README.md index 31de168eb46..6695cff5f91 100644 --- a/firebase-database/README.md +++ b/firebase-database/README.md @@ -7,35 +7,6 @@ in realtime to every connected client. When you build cross-platform apps with o and JavaScript SDKs, all of your clients share one Realtime Database instance and automatically receive updates with the newest data. -All Gradle commands should be run from the source root (which is one level up from this folder). - -Building -======== -You can build the SDK by invoking `./gradlew :firebase-database:assemble`. - -If you want to test changes locally, you may also run -`./gradlew -PprojectsToPublish="firebase-database" firebasePublish`. This generates the Maven -dependency tree (under `build/`) that you can use during app development. - -Testing -======= - -To run the unit tests: - -- Invoke `./gradlew :firebase-database:check`. - -To run the integration tests: - -- Make sure that you have configured a `google-service.json` from your Firebase test project in the - source root. -- For now, you have to disable security rule enforcement for the Realtime Databse in your test - project. -- Start an Android Emulator. -- Invoke `./gradlew :firebase-database:connectedCheck`. -- Re-enable your security rules after your test run. - - -Formatting -========== -Format your source files via `./gradlew :firebase-database:googleJavaFormat` - +All Gradle commands should be run from the source root (which is one level up +from this folder). See the README.md in the source root for instructions on +publishing/testing the Realtime Database. diff --git a/firebase-firestore/README.md b/firebase-firestore/README.md index 8c16c787dd2..1a90f029ec2 100644 --- a/firebase-firestore/README.md +++ b/firebase-firestore/README.md @@ -1 +1,15 @@ -Prior to submitting please run `./gradlew :firebase-firestore:googleJavaFormat` to format your code. +# firebase-firestore + +This is the Cloud Firestore component of the Firebase Android SDK. + +Cloud Firestore is a flexible, scalable database for mobile, web, and server +development from Firebase and Google Cloud Platform. Like Firebase Realtime +Database, it keeps your data in sync across client apps through realtime +listeners and offers offline support for mobile and web so you can build +responsive apps that work regardless of network latency or Internet +connectivity. Cloud Firestore also offers seamless integration with other +Firebase and Google Cloud Platform products, including Cloud Functions. + +All Gradle commands should be run from the source root (which is one level up +from this folder). See the README.md in the source root for instructions on +publishing/testing Cloud Firestore. diff --git a/firebase-storage/README.md b/firebase-storage/README.md index 90fe835bc66..3e29024ffb5 100644 --- a/firebase-storage/README.md +++ b/firebase-storage/README.md @@ -8,36 +8,6 @@ downloads for your Firebase apps, regardless of network quality. You can use our images, audio, video, or other user-generated content. On the server, you can use Google Cloud Storage, to access the same files. -All Gradle commands should be run from the source root (which is one level up from this folder). - -Building -======== -You can build the SDK by invoking `./gradlew :firebase-storage:assemble`. - -If you want to test changes locally, you may also run -`./gradlew -PprojectsToPublish="firebase-storage" firebasePublish`. This generates the Maven -dependency tree (under `build/`) that you can use during app development. - -Testing -======= - -To run the unit tests: - -- Invoke `./gradlew :firebase-storage:check`. - -To run the integration tests: - -- Make sure that you have configured a `google-service.json` from your Firebase test project in the - source root. -- Enable Firebase Storage in your project. Firebase Storage can be implicitly enabled by visiting - the Storage tab in the [Firebase Console](https://console.firebase.google.com/). -- For now, you have to disable security rule enforcement for Cloud Storage in your test project. -- Start an Android Emulator. -- Invoke `./gradlew :firebase-storage:connectedCheck`. -- Re-enable your security rules after your test run. - - -Formatting -========== -Format your source files via `./gradlew :firebase-storage:googleJavaFormat` - +All Gradle commands should be run from the source root (which is one level up +from this folder). See the README.md in the source root for instructions on +publishing/testing Firebase Storage.