React native documentation

docs/react-native.md

@@ -0,0 +1,44 @@
+# React Native
+
+## Installing React Native Expo
+
+We use [Expo](https://expo.dev/) to help us develop our application. Install the command line tool so you can run Expo commands.
+
+```
+npm install -g expo-cli
+```
+
+## Running the application
+
+Open `Metro Bundler` (deployment server) for testing and deployment purposes.
+
+```
+pnpm run mobile
+```
+
+`Metro Bundler` gives you the chance to test our application on an `Android` simulator, `iOS` simulator, `web` or on a real device.
+
+![Deployment options](./images/metro_bundler_deploy_options.png)
+
+Testing on `iOS` requires `macOS` and [Xcode](https://developer.apple.com/xcode/).
+On the other hand, [Android Studio](https://developer.android.com/studio?gclid=Cj0KCQiAuvOPBhDXARIsAKzLQ8HSP0n1tojsRjsEZhT2cWmUrps8u4oND0eAONViZsf9rqMk2gFpc_waAtJOEALw_wcB&gclsrc=aw.ds) provides virtual `Android` machine for testing purposes.
+
+In `Metro Bundler`, you can choose to generate `QR` code with the `tunnel` connection to have the app running on your physical device.
+
+![Tunnel deploy options](./images/tunnel_deploy_option.png)
+
+Note: For `macOS` more [configuration](https://docs.expo.dev/workflow/android-studio-emulator/) is needed if you want to use `Android Studio` to test the application
+
+## Debugging
+
+To bring up the developer menu:
+
+![Developer menu](./images/developer_menu.png)
+
+- On `Android` virtual machine: Cmd ⌘ + M or Ctrl + M
+- On `iOS` virtual machine: Cmd ⌘ + D (on `iOS` sometimes you will have to use Ctrl + D then Cmd ⌘ + D) or Ctrl + D
+- On physical devices: shake your device
+
+Click on `debug remote JS` and then you can work on debugging the application using `Chrome developer tool`
+
+Note: Remember to turn off `Remote JS debugging` mode or it will slow down the application

package.json

@@ -33,7 +33,8 @@
     "services:clean": "node bin/services-clean.js",
     "prepare": "husky install",
     "preinstall": "npx only-allow pnpm",
-    "postinstall": "cd src/mobile && npm install"
+    "postinstall": "cd src/mobile && npm install",
+    "mobile": "cd src/mobile && expo start"
   },
   "repository": "Seneca-CDOT/telescope",
   "license": "BSD-2-Clause",