Added instructions for running local xmtp server/unit tests locally (#…

…173) * Added instructions for running local xmtp server for testing unit tests on local emulators * Update example/README.md Co-authored-by: J-Ha <[email protected]> * Update example/README.md Co-authored-by: J-Ha <[email protected]> * Update example/README.md Co-authored-by: J-Ha <[email protected]> * Update example/README.md Co-authored-by: J-Ha <[email protected]> * Update example/README.md Co-authored-by: J-Ha <[email protected]> * Update example/README.md Co-authored-by: J-Ha <[email protected]> * Update example/README.md Co-authored-by: J-Ha <[email protected]> --------- Co-authored-by: Cameron Voell <[email protected]> Co-authored-by: J-Ha <[email protected]>
xmtp · Dec 8, 2023 · cebc2d5 · cebc2d5
1 parent 8a3d762
commit cebc2d5
Show file tree

Hide file tree

Showing 2 changed files with 41 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -18,13 +18,14 @@ Access the `xmtp-react-native` client SDK [reference documentation](https://xmtp
 
 ## Example app
 
-Use the [XMTP React Native example app](example) as a tool to start building an app with XMTP. This basic messaging app has an intentionally unopinionated UI to help make it easier for you to build with.
+Use the [XMTP React Native example app](example) as a tool to start building an app with XMTP. This basic messaging app has an intentionally unopinionated UI to help make it easier for you to build with. [See example/README.md](example/README.md) for more instructions.
 
-Follow the [React Native guide](https://reactnative.dev/docs/environment-setup) to set up a CLI environment.
+### Quickstart to use the example app:
 
-To use the example app, run:
+Follow the [React Native guide](https://reactnative.dev/docs/environment-setup) to set up a CLI environment.
 
 ```bash
+npm install
 cd example
 npm install --force
 npm run [ios or android]

diff --git a/example/README.md b/example/README.md
@@ -0,0 +1,37 @@
+# XMTP React Native example app
+
+This basic messaging app has an intentionally unopinionated UI to help make it easier for you to build with.
+
+## Run the example app
+Follow the [React Native guide](https://reactnative.dev/docs/environment-setup) to set up a CLI environment.
+
+To use the example app, run:
+
+```bash
+npm install
+cd example
+npm install --force
+npm run [ios or android]
+```
+
+## Run example app unit tests on local emulators
+Running tests locally is useful when updating GitHub actions, or locally testing between changes.
+
+1. [Install Docker](https://docs.docker.com/get-docker/)
+
+2. Start a local XMTP server (from example directory)
+    ```bash
+    docker-compose -p xmtp -f dev/local/docker-compose.yml up -d
+    ```
+3. Verify the XMTP server is running
+    ```bash
+    docker-compose ls
+
+    NAME                STATUS              CONFIG FILES
+    xmtp                running(3)          <REPO_DIRECTORY>/xmtp-react-native/example/dev/local/docker-compose.yml
+    ```
+4. You can now run unit tests on your local emulators
+5. You can stop the XMTP server with the following command:
+    ```bash
+    docker-compose -p xmtp -f dev/local/docker-compose.yml down
+    ```