Firefox for Amazon's Fire TV

Fast for good, just right for watching video at home. A browser for discovering and watching web video on the big screen TV for users to install on their Amazon Fire TV and Fire TV stick.

Get it on Amazon Fire TV

Getting Involved

Our code is open source and we encourage all positive contributions! We love pull requests, bug reports, ideas, (security) code reviews and other kinds of contributions. Before you contribute, please read the Community Participation Guidelines.

• Guide to Contributing (new contributors start here!)
• Open issues: https://github.com/mozilla-mobile/firefox-tv/issues
  • good first issues | help wanted
  • File a security issue
• Project wiki: https://github.com/mozilla-mobile/firefox-tv/wiki
• IRC: #focus (irc.mozilla.org) | view logs; we're available Monday-Friday, GMT and PST working hours.
• Mailing list: firefox-focus-public@

Build instructions

1. Clone the repository:

git clone https://github.com/mozilla-mobile/firefox-tv

2. Import the project into Android Studio or build on the command line:

./gradlew clean app:assembledebug

3. Make sure to select the right build variant in Android Studio: debug

Running

It is recommended to test directly on a Fire TV: see the developer guide for more info. You can connect with:

adb connect <IP address>

And then install via Android Studio or adb. Only a single development device can be connected to a Fire TV at a time. Note that while you can install on an Android TV emulator, the behavior is different from Fire TV's and should not be relied upon.

When using an emulator, you can press cmd+m to simulate a menu button press.

Pre-push hooks

To reduce review turn-around time, we'd like all pushes to run tests locally. We'd recommend you use our provided pre-push hook in quality/pre-push-recommended.sh. Using this hook will guarantee your hook gets updated as the repository changes. This hook tries to run as much as possible without taking too much time.

To add it, run this command from the project root:

ln -s ../../quality/pre-push-recommended.sh .git/hooks/pre-push

To push without running the pre-push hook (e.g. doc updates):

git push <remote> --no-verify

Building with API keys

Certain services require an API key, so you'll need to build with the key to use them in the apk.

1. To build with the API key (for services such as Sentry), add a <project-dir>/.<service>_debug file with your key, for example, <project-dir>/.sentry_dsn_debug

   1. To enable Sentry on Debug builds, additionally replace the DataUploadPreference.isEnabled value with true (upload is disabled by default in dev builds).

2. Verify the key add was successful. The gradle output is the only way to verify this (although it won't indicate if the key is valid). You will see a message in the gradle output indicating the key was added:

Sentry DSN (amazonWebviewDebug): Added from /Users/mcomella/dev/moz/firefox-tv/.sentry_dsn_debug

As opposed to:

Sentry DSN (amazonWebviewDebug): X_X

API services currently supported are:

• sentry_dsn
• pocket_key

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/