Offlin33er commited on
Commit
770eec0
Β·
verified Β·
1 Parent(s): 5898419

README: actual APK sizes and names from v0.5.0 build

Browse files
Files changed (1) hide show
  1. README.md +62 -66
README.md CHANGED
@@ -1,99 +1,95 @@
1
- # Nova Browser 🦎⚑
2
 
3
- **Not a conventional browser.** Nova is a chrome-less, unrestricted GeckoView browser whose entire interface is a **command palette**.
4
 
5
- ## What makes it different
 
 
 
 
6
 
7
- ### 1. Chrome-less by design
8
- No URL bar. No toolbar row. No tab strip. Content is edge-to-edge, full screen. One floating **⌘** button summons the command palette β€” everything routes through it:
9
 
10
- - Type anything β†’ **Go to …** / **πŸ” Search DuckDuckGo**
11
- - `New tab` Β· `Close current tab` Β· `Reload page` Β· `Open tab tray` Β· `Add-ons manager` Β· `Dev console` Β· `Clear console`
12
- - A thin loading bar hugs the top edge β€” that's the only persistent indicator.
13
-
14
- ### 2. Unrestricted defaults (deliberately unlike mainstream browsers)
15
- | Restriction | Conventional browsers | Nova |
16
- |---|---|---|
17
- | Tracking protection / content blocking | ON by default | **OFF** β€” no ContentBlocking policy configured |
18
- | Extension permission prompts | Dialog per install | **Auto-granted** (`AUTO_GRANT_PERMISSIONS = true` in `BrowserActivity`; flip to `false` to restore prompts) |
19
- | `about:config` | Hidden/blocked | **Enabled** β€” full engine configuration surface |
20
- | Remote debugging | Off | **Always on** β€” desktop Firefox DevTools via `about:debugging` |
21
- | DevTools (Eruda) | None | **Injected into every page** |
22
-
23
- **Engine-level limit (not embedder-fixable):** Gecko validates add-on signatures at install time β€” unsigned `.xpi` installs are refused by the engine regardless of app settings. Privileged extensions ship inside the APK (Nova's dev console does exactly that).
24
-
25
- ### 3. Real WebExtensions
26
- - Bundled `devconsole@nova` (privileged, `ensureBuiltIn`) β€” Eruda in every page, console logs bridged to the native screen
27
- - AMO installs: `.xpi` URL or add-on page URL β†’ `WebExtensionController.install()` β†’ Gecko validates Mozilla signature β†’ permissions auto-granted in unrestricted mode
28
- - Add-ons manager: list, enable/disable, uninstall
29
-
30
- ### 4. Developer console, three layers
31
- 1. **Eruda** in-page inspector (console / DOM / network)
32
- 2. **Native console screen** via native messaging (`⌘ β†’ Dev console`)
33
- 3. **Remote debugging**: `about:config` from desktop Firefox DevTools
34
-
35
- ## Versions
36
-
37
- | Version | Milestone |
38
  |---|---|
39
- | 0.1.0 | M0 GeckoView shell, tabs, bundled dev-console extension, remote debugging |
40
- | 0.2.0 | M1 tab tray, session restore, VIEW-intent handling |
41
- | 0.3.0 | M2 loading bar, live URL sync, back/fwd states, history autocomplete |
42
- | 0.4.0 | M3 add-ons manager + M4 native console screen |
43
- | 0.5.0 | M5 AMO installs + permission flow (superseded pre-release β€” never shipped) |
44
- | **0.6.0** | **The pivot: chrome-less ⌘ palette + unrestricted defaults** |
 
 
45
 
46
  ## Which APK to install
47
 
48
- In [`apk/`](apk/):
49
 
50
- | File | Use |
51
- |---|---|
52
- | `nova-browser-0.6.0-arm64-release.apk` | **Most modern phones** β€” small, optimized |
53
- | `nova-browser-0.6.0-universal-release.apk` | Any device |
54
- | `nova-browser-0.6.0-debug.apk` | Debug build with all ABIs |
55
 
56
- Release builds are debug-signed (installable for testing).
57
 
58
  ## Build it
59
 
60
- 1. [Android Studio](https://developer.android.com/studio) (2024.2+) β†’ clone https://huggingface.co/datasets/Offlin33er/nova-browser β†’ sync.
61
- 2. `curl -L -o app/src/main/assets/devconsole/eruda.min.js https://cdn.jsdelivr.net/npm/eruda/eruda.min.js`
62
- 3. Run β–Ά (minSdk 26).
 
 
 
 
 
 
63
 
64
- ## Dependency pins (cloud-build verified)
65
 
66
  | Dependency | Version |
67
  |---|---|
68
- | `org.mozilla.geckoview:geckoview` | `147.0.20260212191108` |
69
  | AGP / Gradle | 8.9.1 / 8.11.1 |
70
  | Kotlin | 2.2.21 + built-in Compose compiler plugin |
71
  | Compose BOM | 2024.09.03 |
72
  | minSdk / compileSdk | 26 / 36 |
73
 
74
- ## Layout
75
 
76
  ```
77
  app/src/main/java/dev/nova/browser/
78
- BrowserActivity.kt β€” chrome-less shell, ⌘ FAB, unrestricted runtime config
79
- CommandPalette.kt β€” the primary UI: commands, navigate, search
80
- TabManager.kt β€” sessions, persistence/restore, history, extension registry
81
- TabTray.kt β€” tab management (via palette)
82
- ExtensionManagerScreen.kt β€” add-ons: list, toggle, uninstall, AMO install
83
- ConsoleScreen.kt β€” full dev console
 
84
  app/src/main/assets/devconsole/
85
- manifest.json β€” privileged built-in extension
86
- eruda-loader.js β€” Eruda injection + console bridge
87
  background.js β€” extension background script
88
  ```
89
 
90
- ## Honest notes
 
 
 
 
 
 
 
 
 
 
 
 
91
 
92
- - **Auto-granted permissions are a real security trade-off** β€” that's the point of the product, but it means installed add-ons get what they ask for without a gate. It's one constant (`AUTO_GRANT_PERMISSIONS`) to flip if you ever want prompts back.
93
- - Session restore is URL-level (no scroll/state capture yet).
94
- - Release builds are debug-signed and not R8-minified.
95
- - Eruda exposes page internals β€” you chose unrestricted; mainstream browsers deliberately don't.
96
 
97
  ## License
98
 
99
- MPL-2.0.
 
1
+ # Nova Browser 🦎
2
 
3
+ A sophisticated Android browser built on **GeckoView** with:
4
 
5
+ - **Real WebExtensions support** β€” install from AMO, enable/disable/uninstall, permission prompts
6
+ - **Built-in developer console** β€” in-page inspector (Eruda) + native console screen + remote debugging from desktop Firefox DevTools
7
+ - Multi-tab engine, tab tray, session restore, loading bar, history autocomplete
8
+ - **Tracking protection** enabled out of the box (ContentBlocking: ad/analytic/social/test trackers + non-tracker cookie policy)
9
+ - **Release builds with per-ABI splits** β€” ~192 MB arm64 release vs 517 MB universal debug
10
 
11
+ ## Status β€” milestones shipped (roadmap complete βœ…)
 
12
 
13
+ | Milestone | Status |
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
14
  |---|---|
15
+ | M0 β€” GeckoView shell, tabs, dev-console extension, remote debugging | βœ… v0.1.0 |
16
+ | M1 β€” tab tray, session restore across restarts, VIEW-intent link handling | βœ… v0.2.0 |
17
+ | M2 β€” toolbar polish: loading bar, live URL sync, back/fwd states, history autocomplete | βœ… v0.3.0 |
18
+ | M3 β€” add-ons manager screen (list, enable/disable) | βœ… v0.4.0 |
19
+ | M4 β€” full native Console screen | βœ… v0.4.0 |
20
+ | M5 β€” AMO `.xpi` install flow with permission prompts + uninstall | βœ… v0.5.0 |
21
+ | M6 β€” release build with ABI splits, debug-signed + tracking protection | βœ… v0.5.0 |
22
+ | Deferred (post-1.0): downloads manager, reader mode, private-mode UI, R8 minify, real release signing | β€” |
23
 
24
  ## Which APK to install
25
 
26
+ In [`apk/`](apk/) β€” exact names/sizes from the v0.5.0 build:
27
 
28
+ | File | Size | Use |
29
+ |---|---|---|
30
+ | `nova-browser-0.5.0-arm64-release.apk` | 192 MB | **Most modern phones** |
31
+ | `nova-browser-0.5.0-universal-release.apk` | 514 MB | Any device (larger) |
32
+ | `nova-browser-0.5.0-debug.apk` | 518 MB | Debug build with all ABIs |
33
 
34
+ Release builds are debug-signed (installable for testing); ship with a real keystore for distribution.
35
 
36
  ## Build it
37
 
38
+ 1. Install [Android Studio](https://developer.android.com/studio) (2024.2 or newer).
39
+ 2. Clone this repo: https://huggingface.co/datasets/Offlin33er/nova-browser
40
+ 3. Open in Android Studio and sync.
41
+ 4. Download the inspector bundle once:
42
+ ```
43
+ curl -L -o app/src/main/assets/devconsole/eruda.min.js \
44
+ https://cdn.jsdelivr.net/npm/eruda/eruda.min.js
45
+ ```
46
+ 5. Run β–Ά on a device or emulator (minSdk 26).
47
 
48
+ ## Dependency pins (verified, cloud-build tested)
49
 
50
  | Dependency | Version |
51
  |---|---|
52
+ | `org.mozilla.geckoview:geckoview` (stable) | `147.0.20260212191108` β€” [maven.mozilla.org](https://maven.mozilla.org/maven2/org/mozilla/geckoview/) |
53
  | AGP / Gradle | 8.9.1 / 8.11.1 |
54
  | Kotlin | 2.2.21 + built-in Compose compiler plugin |
55
  | Compose BOM | 2024.09.03 |
56
  | minSdk / compileSdk | 26 / 36 |
57
 
58
+ ## Project layout
59
 
60
  ```
61
  app/src/main/java/dev/nova/browser/
62
+ BrowserActivity.kt β€” activity: runtime (content blocking), UI shell, overlays,
63
+ restore, intents, install-permission prompt delegate
64
+ TabManager.kt β€” one GeckoSession per tab, session persistence/restore,
65
+ nav/loading state, history, extension registry + installs
66
+ TabTray.kt β€” M1 full-screen tab tray
67
+ ExtensionManagerScreen.kt β€” M3/M5 add-ons manager (list, toggle, uninstall, AMO install)
68
+ ConsoleScreen.kt β€” M4 full console screen
69
  app/src/main/assets/devconsole/
70
+ manifest.json β€” privileged built-in extension (geckoViewAddons, nativeMessaging)
71
+ eruda-loader.js β€” content script: injects Eruda, bridges console logs
72
  background.js β€” extension background script
73
  ```
74
 
75
+ ## Dev console β€” the layers
76
+
77
+ 1. **In-page inspector**: bundled `devconsole@nova` extension injects [Eruda](https://github.com/liriliri/eruda) into every page.
78
+ 2. **Native console screen**: console output bridged over **native messaging** into the full-screen Console screen (newest first, clearable) + a 3-line shell preview.
79
+ 3. **Remote debugging**: `runtime.settings.setRemoteDebuggingEnabled(true)` β€” desktop Firefox DevTools attach via `about:debugging`.
80
+
81
+ ## Extensions
82
+
83
+ - **Bundled**: `devconsole@nova` (privileged, `ensureBuiltIn`).
84
+ - **AMO installs (M5)**: paste an AMO add-on URL or `.xpi` link in the Add-ons screen β†’ `WebExtensionController.install(uri)`; Gecko downloads + validates the Mozilla signature, then `onInstallPromptRequest` surfaces a permission dialog (Allow/Deny). Installs persist across restarts. Uninstall available for non-builtin add-ons.
85
+ - **Privacy**: runtime `ContentBlocking` policy (`AntiTracking.DEFAULT` + `CookieBehavior.ACCEPT_NON_TRACKERS`) + per-session `useTrackingProtection(true)`.
86
+
87
+ ## Known simplifications
88
 
89
+ - Session restore is URL-level (no scroll/state capture β€” `saveState()`/`restoreState()` is the next step).
90
+ - Install prompt grants `permissions` but not private-mode or data-collection flags (safe defaults).
91
+ - Release builds are debug-signed and not minified β€” R8 pass still to do.
 
92
 
93
  ## License
94
 
95
+ MPL-2.0 (matches the Mozilla components this builds on).