Skip to content

Commit 9c63218

Browse files
authored
Adjust a few READMEs to eliminate some redundancy (#4)
Build/publish/test commands are common across the projects, so we can just refer to them in the top level README rather than repeating them in the sub-READMEs.
1 parent fe18102 commit 9c63218

File tree

4 files changed

+29
-66
lines changed

4 files changed

+29
-66
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,11 @@ If you don't have a suitable testing project already:
8787
* Download the resulting `google-services.json` file and put it in the root of
8888
your checkout.
8989

90+
For now, you have to disable security rule enforcement for the Realtime
91+
Database, Cloud Firestore, and Cloud Storage in your test project (if running
92+
the integration tests for any of those). Re-enable your security rules after
93+
your test run.
94+
9095
#### Running Integration Tests
9196

9297
Integration tests can be executed on the command line by running
@@ -204,6 +209,9 @@ projects may be published as follows.
204209
publishProjectsToMavenLocal
205210
```
206211

212+
To generate the Maven dependency tree under `build/` instead, you can replace
213+
`publishProjectsToMavenLocal` in the above command with `firebasePublish`.
214+
207215
### Code Formatting
208216

209217
Code in this repo is formatted with the google-java-format tool. You can enable

firebase-database/README.md

Lines changed: 3 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -7,35 +7,6 @@ in realtime to every connected client. When you build cross-platform apps with o
77
and JavaScript SDKs, all of your clients share one Realtime Database instance and automatically
88
receive updates with the newest data.
99

10-
All Gradle commands should be run from the source root (which is one level up from this folder).
11-
12-
Building
13-
========
14-
You can build the SDK by invoking `./gradlew :firebase-database:assemble`.
15-
16-
If you want to test changes locally, you may also run
17-
`./gradlew -PprojectsToPublish="firebase-database" firebasePublish`. This generates the Maven
18-
dependency tree (under `build/`) that you can use during app development.
19-
20-
Testing
21-
=======
22-
23-
To run the unit tests:
24-
25-
- Invoke `./gradlew :firebase-database:check`.
26-
27-
To run the integration tests:
28-
29-
- Make sure that you have configured a `google-service.json` from your Firebase test project in the
30-
source root.
31-
- For now, you have to disable security rule enforcement for the Realtime Databse in your test
32-
project.
33-
- Start an Android Emulator.
34-
- Invoke `./gradlew :firebase-database:connectedCheck`.
35-
- Re-enable your security rules after your test run.
36-
37-
38-
Formatting
39-
==========
40-
Format your source files via `./gradlew :firebase-database:googleJavaFormat`
41-
10+
All Gradle commands should be run from the source root (which is one level up
11+
from this folder). See the README.md in the source root for instructions on
12+
publishing/testing the Realtime Database.

firebase-firestore/README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,15 @@
1-
Prior to submitting please run `./gradlew :firebase-firestore:googleJavaFormat` to format your code.
1+
# firebase-firestore
2+
3+
This is the Cloud Firestore component of the Firebase Android SDK.
4+
5+
Cloud Firestore is a flexible, scalable database for mobile, web, and server
6+
development from Firebase and Google Cloud Platform. Like Firebase Realtime
7+
Database, it keeps your data in sync across client apps through realtime
8+
listeners and offers offline support for mobile and web so you can build
9+
responsive apps that work regardless of network latency or Internet
10+
connectivity. Cloud Firestore also offers seamless integration with other
11+
Firebase and Google Cloud Platform products, including Cloud Functions.
12+
13+
All Gradle commands should be run from the source root (which is one level up
14+
from this folder). See the README.md in the source root for instructions on
15+
publishing/testing Cloud Firestore.

firebase-storage/README.md

Lines changed: 3 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -8,36 +8,6 @@ downloads for your Firebase apps, regardless of network quality. You can use our
88
images, audio, video, or other user-generated content. On the server, you can use Google Cloud
99
Storage, to access the same files.
1010

11-
All Gradle commands should be run from the source root (which is one level up from this folder).
12-
13-
Building
14-
========
15-
You can build the SDK by invoking `./gradlew :firebase-storage:assemble`.
16-
17-
If you want to test changes locally, you may also run
18-
`./gradlew -PprojectsToPublish="firebase-storage" firebasePublish`. This generates the Maven
19-
dependency tree (under `build/`) that you can use during app development.
20-
21-
Testing
22-
=======
23-
24-
To run the unit tests:
25-
26-
- Invoke `./gradlew :firebase-storage:check`.
27-
28-
To run the integration tests:
29-
30-
- Make sure that you have configured a `google-service.json` from your Firebase test project in the
31-
source root.
32-
- Enable Firebase Storage in your project. Firebase Storage can be implicitly enabled by visiting
33-
the Storage tab in the [Firebase Console](https://console.firebase.google.com/).
34-
- For now, you have to disable security rule enforcement for Cloud Storage in your test project.
35-
- Start an Android Emulator.
36-
- Invoke `./gradlew :firebase-storage:connectedCheck`.
37-
- Re-enable your security rules after your test run.
38-
39-
40-
Formatting
41-
==========
42-
Format your source files via `./gradlew :firebase-storage:googleJavaFormat`
43-
11+
All Gradle commands should be run from the source root (which is one level up
12+
from this folder). See the README.md in the source root for instructions on
13+
publishing/testing Firebase Storage.

0 commit comments

Comments
 (0)