Git Product home page Git Product logo

testpilot-containers's Introduction

Containers Add-on

Available on Test Pilot

Embedded Web Extension to build Containers as a Firefox Test Pilot Experiment and Shield Study to learn:

  • Will a general Firefox audience understand the Containers feature?
  • Is the UI as currently implemented in Nightly clear or discoverable?

For more info, see:

Requirements

  • node 7+ (for jpm)
  • Firefox 53+

Development

Development Environment

Add-on development is better with a particular environment. One simple way to get that environment set up is to install the DevPrefs add-on. You can make a custom Firefox profile that includes the DevPrefs add-on, and use that profile when you run the code in this repository.

  1. Make a new profile by running /path/to/firefox -P, which launches the profile editor. "Create Profile" -- name it whatever you wish (e.g. 'addon_dev') and store it in the default location. It's probably best to deselect the option to "Use without asking," since you probably don't want to use this as your default profile.

  2. Once you've created your profile, click "Start Firefox". A new instance of Firefox should launch. Go to Tools->Add-ons and search for "DevPrefs". Install it. Quit Firefox.

  3. Now you have a new, vanilla Firefox profile with the DevPrefs add-on installed. You can use your new profile with the code in this repository like so:

Run the .xpi file in an unbranded build

Release & Beta channels do not allow un-signed add-ons, even with the DevPrefs. So, you must run the add-on in an unbranded build:

  1. Download and install an un-branded build of Firefox
  2. Download the latest .xpi from this repository's releases
  3. Run the un-branded build of Firefox with your DevPrefs profile
  4. Go to about:addons
  5. Click the gear, and select "Install Add-on From File..."
  6. Select the .xpi file

Run the TxP experiment with jpm

  1. git clone [email protected]:mozilla/testpilot-containers.git
  2. cd testpilot-containers
  3. npm install
  4. ./node_modules/.bin/jpm run -p /Path/To/Firefox/Profiles/{junk}.addon_dev -b FirefoxBeta (where FirefoxBeta might be: ~//obj-x86_64-pc-linux-gnu/dist/bin/firefox or ~//firefox)

Check out the Browser Toolbox for more information about debugging add-on code.

Run the shield study with shield

  1. git clone [email protected]:mozilla/testpilot-containers.git
  2. cd testpilot-containers
  3. npm install
  4. npm install -g shield-study-cli
  5. shield run . -- --binary Nightly

Building .xpi

To build a local testpilot-containers.xpi, use the plain jpm xpi command, or run npm run build.

Building a shield .xpi

To build a local shield-study-containers.xpi, run npm run build-shield.

Signing an .xpi

To sign an .xpi, use jpm sign command.

Note: You will need to be an author on the AMO add-on.

Testing

TBD

Distributing

TBD

testpilot-containers's People

Contributors

groovecoder avatar jonathankingston avatar bakulf avatar johngruen avatar pdehaan avatar jaredhirsch avatar tjfwalker avatar clouserw avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.