Skip to content

Commit 8a2ed6f

Browse files
committed
Improve docs
1 parent 7766b43 commit 8a2ed6f

2 files changed

Lines changed: 26 additions & 181 deletions

File tree

android/README.md

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,12 +116,19 @@ npx cap sync android
116116

117117
### Load from site
118118

119-
During local development, open Android Studio project and run the app on an emulator or your physical device. Note that right now you can't use a physical device for the local web version (`10.0.2.2:3000 time out` )
119+
During local development, open Android Studio project and run the app on an emulator or your physical device.
120120

121+
To use an emulator:
121122
```
122123
npx cap open android
123124
```
124125

126+
To use a physical device for the local web version, you need your mobile and computer to be on the same network / Wi-Fi and point the URL (`LOCAL_BACKEND_DOMAIN` in the code) to your computer IP address (for example, `192.168.1.3:3000`). You also need to set
127+
```
128+
export NEXT_PUBLIC_WEBVIEW_DEV_PHONE=1
129+
```
130+
Then adb install the app your phone (or simply run it from Android Studio on your phone) and the app should be loading content directly from the local code on your computer. You can make changes in the code and it will refresh instantly on the phone.
131+
125132
Building the Application:
126133
1. Open Android Studio.
127134
2. Click on "Open an existing Android Studio project".
@@ -175,6 +182,10 @@ adb install -r app/build/outputs/apk/debug/app-debug.apk
175182
./gradlew assembleRelease
176183
```
177184

185+
### Release on App Stores
186+
187+
To release on the app stores, you need to submit the .aab files, which are not signed, instead of APK. Google or Apple will then sign it with their own key.
188+
178189
---
179190
## 9. Debugging
180191

@@ -362,3 +373,17 @@ await admin.messaging().send(message)
362373
```
363374

364375
---
376+
377+
## Deep link / custom scheme
378+
379+
A **custom scheme** is a URL protocol that your app owns.
380+
Example:
381+
382+
```
383+
com.compassconnections.app://auth
384+
```
385+
386+
387+
When Android (or iOS) sees a redirect to one of these URLs, it **launches your app** and passes it the URL data. It's useful to open links in the app instead of the browser. For example, if there's a link to Compass on Discord and we click on it on a mobile device that has the app, we want the link to open in the app instead of the browser.
388+
389+
You register this scheme in your `AndroidManifest.xml` so Android knows which app handles it.

docs/webview_oauth_signin.md

Lines changed: 0 additions & 180 deletions
This file was deleted.

0 commit comments

Comments
 (0)