Offlin33er commited on
Commit
bbb5922
Β·
verified Β·
1 Parent(s): 5d3a909

Nova Browser project README

Browse files
Files changed (1) hide show
  1. README.md +57 -0
README.md ADDED
@@ -0,0 +1,57 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Nova Browser 🦎
2
+
3
+ A sophisticated Android browser built on **GeckoView** with:
4
+
5
+ - **Real WebExtensions support** β€” the Firefox add-on model, powered by `WebExtensionController`
6
+ - **Built-in developer console** β€” in-page inspector (Eruda) + console-log bridge to the native UI + remote debugging from desktop Firefox DevTools
7
+ - Multi-tab engine, URL bar, and a clean Kotlin/Compose UI shell to grow from
8
+
9
+ ## Build it
10
+
11
+ 1. Install [Android Studio](https://developer.android.com/studio) (Koala 2024.1 or newer).
12
+ 2. Clone this repo (or download as zip): https://huggingface.co/datasets/Offlin33er/nova-browser
13
+ 3. Open the folder in Android Studio and let it sync (Gradle 8.x, AGP 8.5.2, Kotlin 1.9.24).
14
+ 4. Download the inspector bundle once:
15
+ ```
16
+ curl -L -o app/src/main/assets/devconsole/eruda.min.js \
17
+ https://cdn.jsdelivr.net/npm/eruda/eruda.min.js
18
+ ```
19
+ (`eruda-loader.js` also falls back to the CDN at runtime if the file is missing.)
20
+ 5. Run β–Ά on a device or emulator (minSdk 24).
21
+
22
+ ## Dependency pins (verified)
23
+
24
+ | Dependency | Version |
25
+ |---|---|
26
+ | `org.mozilla.geckoview:geckoview` (stable) | `147.0.20260212191108` β€” confirmed on [maven.mozilla.org](https://maven.mozilla.org/maven2/org/mozilla/geckoview/) |
27
+ | AGP | 8.5.2 |
28
+ | Kotlin | 1.9.24 (Compose compiler 1.5.14) |
29
+ | Compose BOM | 2024.09.03 |
30
+
31
+ To bump GeckoView, pick the newest version string from the Mozilla Maven index above and edit `app/build.gradle.kts`.
32
+
33
+ ## Project layout
34
+
35
+ ```
36
+ app/src/main/java/dev/nova/browser/
37
+ BrowserActivity.kt β€” activity: runtime, UI, tab switching, messaging
38
+ TabManager.kt β€” one GeckoSession per tab, activate/close
39
+ app/src/main/assets/devconsole/
40
+ manifest.json β€” privileged built-in extension (geckoViewAddons, nativeMessaging)
41
+ eruda-loader.js β€” content script: injects Eruda, bridges console logs
42
+ ```
43
+
44
+ ## Dev console β€” the two layers
45
+
46
+ 1. **In-page inspector**: the bundled `devconsole@nova` extension injects [Eruda](https://github.com/liriliri/eruda) into every page (console, DOM, network). Console output is also forwarded over GeckoView **native messaging** (`sendNativeMessage("browser", ...)`) to `NovaMessageDelegate` in the app, which logs it and feeds the native Console screen.
47
+ 2. **Remote debugging**: `runtime.settings.setDebugSupportEnabled(true)` is set at startup β€” open `about:debugging` in desktop Firefox and connect over USB/Wi-Fi to attach full DevTools.
48
+
49
+ ## Roadmap
50
+
51
+ M0 shell (this repo) β†’ M1 tab tray + restore β†’ M2 navigation/toolbar polish β†’ M3 extension manager + action buttons β†’ M4 native Console screen β†’ M5 AMO `.xpi` install flow β†’ M6 privacy, storage, reader mode, release.
52
+
53
+ See the blueprint & course document for the full 12-module development curriculum.
54
+
55
+ ## License
56
+
57
+ MPL-2.0 (matches the Mozilla components this builds on).