aboutsummaryrefslogtreecommitdiffhomepage
path: root/Functions/README.md
diff options
context:
space:
mode:
authorGravatar Paul Beusterien <paulbeusterien@google.com>2018-03-20 11:59:03 -0700
committerGravatar GitHub <noreply@github.com>2018-03-20 11:59:03 -0700
commitb7f35a0b76bb2afd682b806d2b25568611612557 (patch)
treedeb4577d3e54c3fafa2a065605faef228a186c1b /Functions/README.md
parent7e65885762757209e0e14ec28e99ec91380e9c2f (diff)
Initial Firebase Functions (#948)
Diffstat (limited to 'Functions/README.md')
-rw-r--r--Functions/README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/Functions/README.md b/Functions/README.md
new file mode 100644
index 0000000..f0b8d62
--- /dev/null
+++ b/Functions/README.md
@@ -0,0 +1,21 @@
+# Cloud Functions for Firebase iOS SDK
+
+## To run unit tests
+
+Choose the FirebaseFunctions_Tests scheme and press Command-u.
+
+## To run integration tests
+
+Before running the integration tests, you'll need to start a backend emulator
+for them to talk to.
+
+1. Make sure you have `npm` installed.
+2. Run the backend startup script: `Backend/start.sh`
+ It will use `npm install` to automatically download the libraries it needs
+ to run the [Cloud Functions Local Emulator](https://cloud.google.com/functions/docs/emulator).
+ The first time you run it, it will ask for a projectId.
+ You can put anything you like. It will be ignored.
+3. Create the workspace in Functions/Example with `pod install`.
+4. `open FirebaseFunctions.xcworkspace`
+5. Choose the FirebaseFunctions_IntegrationTests scheme and press Command-u.
+6. When you are finished, you can press any key to stop the backend.