Skip to content

Commit b22d6a7

Browse files
committed
Update readme
1 parent f91d912 commit b22d6a7

1 file changed

Lines changed: 6 additions & 8 deletions

File tree

android/README.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
11
# Compass Android WebView App
22

33
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.
75

86
This document describes how to:
97
1. Build and run the web frontend and backend locally
@@ -15,7 +13,7 @@ This document describes how to:
1513

1614
## 1. Project Overview
1715

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.
1917

2018
During development, it can instead load the local frontend (`http://10.0.2.2:3000`) and backend (`http://10.0.2.2:8088`).
2119

@@ -35,17 +33,17 @@ Project Structure
3533
- **Reliability:** Works offline or in poor connectivity environments.
3634
- **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).
3735
- **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:
4039
- **Internal enterprise apps** where the WebView just wraps an existing web portal.
4140
- **Dynamic content** or **frequent updates** where pushing a new web build every time through app stores would be too slow.
4241
- To leverage the low latency of ISR and SSR.
43-
4442
However, this approach requires:
4543
- Careful handling of **CORS**, **SSL**, and **login/session** persistence.
4644
- Compliance with **Google Play policies** (they may reject apps that are “just a webview of a website” unless there’s meaningful native integration).
4745

48-
A middle ground we use:
46+
**A middle ground we use:**
4947
- The app ships with **local assets** for core functionality.
5048
- The app **fetches remote content or updates** (e.g., via Capacitor Live Updates, Ionic Appflow).
5149

0 commit comments

Comments
 (0)