abdhilahirwabwire / reference_browser

A full-featured browser reference implementation using Mozilla Android Components.

Reference Browser

A web browser reference implementation using Mozilla Android Components.

The Reference Browser is not a product intended to ship to end users. Instead it is a Technology Preview for many new mobile components that multiple teams at Mozilla are currently working on

It includes the Mozilla Web Platform via GeckoView, a new modern Firefox Accounts and Cloud Sync implementation and the new "Glean" telemetry library. All these components will be foundational for Mozilla's existing and upcoming Android products.

The Reference Browser can also be a starting point for your own new browser-like applications. It depends heavily on the Android Components project where most of the actual implementation lives. That project also includes many smaller sample applications.

Will Reference Browser move to mozilla-central?

Reference Browser is meant to be a reference implementation of the Android Components project. Having it live outside of the mozilla source-tree lets us:

1. See how core browsing APIs work for browser-based projects outside of Firefox.
2. Have a developer playground to try experimental APIs in a safe way that involves a full build, signing, and publishing process.
3. Validates that our maven repositories and Google Play publishing infrastructure is still functioning - if we no longer receive maven artifacts or Google Play builds are not working, we would know that there is something systematically wrong with these processes.

Getting Involved

We encourage you to participate in this open source project. We love pull requests, bug reports, ideas, (security) code reviews or any kind of positive contribution.

Before you attempt to make a contribution please read the Community Participation Guidelines.

• View current Issues or View current Pull Requests.

• IRC: #android-components (irc.mozilla.org) | view logs

• Subscribe to our mailing list android-components@ to keep up to date (Archives).

Test Channel on Google Play Store

To get the Reference Browser on your device, follow these two steps:

1. Visit https://groups.google.com/forum/#!forum/mozilla-reference-browser and join the Google Group
2. Visit https://play.google.com/apps/testing/org.mozilla.reference.browser on your device to join the test program and to install the app

Make sure you use the same Google Account for both steps.

Download Nightly Builds Directly

Signed Nightly builds can be downloaded from:

• ⬇️ ARM64/Aarch64 devices (64 bit; Android 5+)
• ⬇️ ARM devices (32 bit; Android 5+)
• ⬇️ x86_64 devices (64 bit; Android 5+)
• ⬇️ x86 devices (32 bit; Android 5+)

Please note that these builds do not auto-update, you will have to keep up to date manually.

The latest Nightly build task can be found here.

Getting Involved

We encourage you to participate in this open source project. We love pull requests, bug reports, ideas, (security) code reviews or any kind of positive contribution.

Before you attempt to make a contribution please read the Community Participation Guidelines.

• View current Issues or View current Pull Requests.

• List of good first issues (New contributors start here!) and List of "help wanted" issues.

• IRC: #android-components (irc.mozilla.org) | view logs

• Subscribe to our mailing list android-components@ to keep up to date (Archives).

Local Development

You might be interested in building this project against local versions of some of the dependencies. Depending on which dependencies you're building against, there are couple of paths.

Auto-publication workflow

This is the most streamlined workflow which fully automates dependency publication. It currently supports android-components and application-services dependencies.

In a local.properties file in root of the reference-browser checkout, specify relative paths to a repository you need (or both):

# Local workflow
autoPublish.android-components.dir=../android-components
autoPublish.application-services.dir=../application-services

That's it! Next build of reference-browser will be against your local versions of these repositories. Simply make changes in android-components or application-services, press Play in reference-browser and those changes will be picked-up.

See a demo of this workflow in action. Video mentions Fenix, but it works in exactly the same with with reference-browser.

Dependency substitutions for GeckoView

GeckoView currently can be configured via a dependency substitution.

In a local.properties file in root of the reference-browser checkout, specify GeckoView's path via dependencySubstitutions.geckoviewTopsrcdir=/path/to/mozilla-central (and, optionally, dependencySubstitutions.geckoviewTopobjdir=/path/to/topobjdir). See Bug 1533465.

This assumes that you have built, packaged, and published your local GeckoView -- but don't worry, the dependency substitution script has the latest instructions for doing that.

Do not forget to run a Gradle sync in Android Studio after changing local.properties. If you specified any substitutions (e.g. GeckoView), they will be reflected in the modules list, and you'll be able to modify them from a single Android Studio window. For auto-publication workflow, use seperate Android Studio windows.

License

This Source Code Form is subject to the terms of the Mozilla Public
License, v. 2.0. If a copy of the MPL was not distributed with this
file, You can obtain one at http://mozilla.org/MPL/2.0/