@hourstack/extension v1.1.1

hourstack-extension

Browser extensions for HourStack

Requirements

Node.js v14

Setup

Download the repository and install dependencies:

git clone git@github.com:hourstack/hourstack-extension
cd hourstack-extension
yarn

Copy .env.sample to .env and fill in the values:

• APP_URL: Base URL for HourStack web app
• API_ENDPOINT: Base URL for HourStack API. Note that the extension and the web app must be pointing to the same API
• BUGSNAG_KEY: Bugsnag API key (optional)
• FIREFOX_ADDON_ID: Unique ID of Firefox add-on (optional unless you want to sideload)

For APP_URL and API_ENDPOINT, you can optionally specify browser-specific values like so:

# Will be used by Chrome and Firefox
APP_URL=http://localhost:3000

# Will be used by Safari
SAFARI_APP_URL=https://app.hourstack.com

Building

• yarn start: build and watch for changes
• yarn build: build once

Testing

To load it in Chrome:

1. Open chrome://extensions
2. In the top right, toggle on "Developer mode" to enable the loading of unpacked extensions
3. In the top left, select "Load unpacked", and select the folder dist/chrome to load the extension

To load it in Firefox:

1. Open about:debugging
2. Select "This Firefox" from the navigation
3. Under "Temporary Extensions", select "Load Temporary Add-on...", and select the file dist/firefox/manifest.json to load the extension

*Note: you have to re-add the extension every time Firefox launches.*

To load it in Safari:

1. In Safari, turn on the Develop menu: Safari > Preferences > Advanced > Show Develop in menu bar
2. In Safari, select Develop > Allow unsigned extensions
3. In Xcode, open the HourStack folder and build the project by clicking the play icon
4. In Safari, open Preferences and turn on the HourStack extension

*Note: you have to re-select "Allow unsigned extensions" every time Safari launches.*

License

MIT © HourStack