Skip to content

Latest commit

 

History

History
51 lines (35 loc) · 1.59 KB

building.md

File metadata and controls

51 lines (35 loc) · 1.59 KB
Raw

Building the extension

This document describes how to build the browser extension and load it into your browser.

Installing the dependencies

You should have Node v4.x installed.

Before continuing, install the development dependencies by running the following at the root of the repository:

$ npm install

Building the extension

The extension build is configured by a JSON settings file, some examples of which are supplied in the settings/ directory. To build the extension, you simply run make. To build the extension in its default configuration (a Chrome development build), run:

$ make

To build the extension from an alternate settings file, simply specify the SETTINGS_FILE variable when running make:

$ make SETTINGS_FILE=settings/chrome-prod.json

This, for example, will build a production extension: one that talks to the main https://hypothes.is web service.

Loading an extension into Chrome

Once you've built the extension, you will be able to load the build/ directory as an unpacked extension:

  1. Go to chrome://extensions/ in Chrome.
  2. Tick Developer mode.
  3. Click Load unpacked extension.
  4. Browse to the build/ directory where the extension was built and select it.

Your extension should be working now! Remember that if you built a development extension it will point to a Hypothesis service running on http://localhost:5000. You may need to have Hypothesis running for the extension to function.