You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: android/README.md
+6-8Lines changed: 6 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,9 +1,7 @@
1
1
# Compass Android WebView App
2
2
3
3
This folder contains the source code for the Android application of Compass.
4
-
A hybrid mobile app built with **Next.js (TypeScript)** frontend, **Firebase backend**, and wrapped as a **Capacitor WebView** for Android.
5
-
Right now it's just a webview wrapper around the web application, but in the future it may
6
-
contain native code as well.
4
+
A hybrid mobile app built with **Next.js (TypeScript)** frontend, **Firebase backend**, and wrapped as a **Capacitor WebView** for Android. In the future it may contain native code as well.
7
5
8
6
This document describes how to:
9
7
1. Build and run the web frontend and backend locally
@@ -15,7 +13,7 @@ This document describes how to:
15
13
16
14
## 1. Project Overview
17
15
18
-
The app is a Capacitor Android project that loads the deployed Next.js site (`https://compassmeet.com`) inside a WebView.
16
+
The app is a Capacitor Android project that loads the local Next.js assests inside a WebView.
19
17
20
18
During development, it can instead load the local frontend (`http://10.0.2.2:3000`) and backend (`http://10.0.2.2:8088`).
21
19
@@ -35,17 +33,17 @@ Project Structure
35
33
-**Reliability:** Works offline or in poor connectivity environments.
36
34
-**App Store policy compliance:** Apple and Google generally prefer that the main experience doesn’t depend on a remote site (for security, review, and performance reasons).
37
35
-**Version consistency:** The web bundle is versioned with the app, ensuring no breaking updates outside your control.
38
-
### **When Remote (No Local Assets) Is Used**
39
-
Loading from a **remote URL** (e.g. `https://myapp.com`) is **less common**, but seen in a few cases:
36
+
37
+
When Remote (No Local Assets) Is sometimes Used
38
+
Loading from a **remote URL** (e.g. `https://compassmeet.com`) is **less common**, but seen in a few cases:
40
39
-**Internal enterprise apps** where the WebView just wraps an existing web portal.
41
40
-**Dynamic content** or **frequent updates** where pushing a new web build every time through app stores would be too slow.
42
41
- To leverage the low latency of ISR and SSR.
43
-
44
42
However, this approach requires:
45
43
- Careful handling of **CORS**, **SSL**, and **login/session** persistence.
46
44
- Compliance with **Google Play policies** (they may reject apps that are “just a webview of a website” unless there’s meaningful native integration).
47
45
48
-
A middle ground we use:
46
+
**A middle ground we use:**
49
47
- The app ships with **local assets** for core functionality.
50
48
- The app **fetches remote content or updates** (e.g., via Capacitor Live Updates, Ionic Appflow).
0 commit comments