docs: RN Dogfood readme update (#1043)

GetStream · Sep 1, 2023 · 5962c03 · 5962c03
1 parent 1fe2492
commit 5962c03
Showing 1 changed file with 27 additions and 10 deletions.
diff --git a/sample-apps/react-native/dogfood/README.md b/sample-apps/react-native/dogfood/README.md
@@ -2,14 +2,31 @@
 
 ## Steps to run the app
 
-1. Move to the root folder of the repo
-2. Run `yarn` to install dependencies
-3. Make sure you have a `.env` file in `sample-apps/react-native/dogfood` with the following keys: `STREAM_API_KEY`
-   and `STREAM_API_SECRET`
-4. Run `yarn build:all` to build the dependent packages
-5. Move to `cd sample-apps/react-native/dogfood/`
-6. Run `npx react-native setup-ios-permissions` to setup permissions (ios only)
-7. Run `npx pod-install` to install pods (ios only)
+1. Clone the `stream-video-js` repository
+```bash
+git clone https://github.com/GetStream/stream-video-js.git
+
+# Step in the directory
+cd stream-video-js
+```
+2. Install and build dependencies
+```bash
+# Install the dependencies
+yarn;
+
+# build the packages
+yarn build: all
+```
+5. Install pods and setup permissions
+```bash
+cd sample-apps/react-native/dogfood
+
+# Setup relevant iOS related permissions
+npx react-native setup-ios-permissions
+
+# Install pods
+npx pod-install
+```
 8. Run the app
    - On simulator: Run `yarn ios` and/or `yarn android` to run the app
    - On device: Run `npm install -g ios-deploy` then `yarn ios --device`
@@ -19,11 +36,11 @@
 - Android: <https://appdistribution.firebase.dev/i/d95ca5c1430d6574>
 - iOS: <https://testflight.apple.com/join/p4Gy0JSM>
 
-## Running the E2E tests
+<!-- ## Running the E2E tests
 
 The following are the steps to run the E2E tests:
 
 - Install [maestro](https://github.com/mobile-dev-inc/maestro) CLI tool.
 - Install [stream-video-buddy](https://github.com/GetStream/stream-video-buddy) CLI tool.
 - Launch the simulator and install the test app by following the instructions above.
-- Start the test flow by running `yarn test-e2e:ios or yarn test-e2e:android` from the root of this project(`/sample-apps/react-native/dogfood`) to run the tests for iOS and Android, respectively. This will run the tests on a device of your choice.
+- Start the test flow by running `yarn test-e2e:ios or yarn test-e2e:android` from the root of this project(`/sample-apps/react-native/dogfood`) to run the tests for iOS and Android, respectively. This will run the tests on a device of your choice. -->