Skip to content

Latest commit

 

History

History
56 lines (39 loc) · 1.91 KB

BUILD.md

File metadata and controls

56 lines (39 loc) · 1.91 KB

Build

Ensure you have

Node.js 16.14.0 is recommended
Yarn v1 or v2 installed

Then run the following:

yarn install to install dependencies.
yarn run dev:chrome to start the development server for chrome extension
yarn run dev:firefox to start the development server for firefox addon
yarn run dev:opera to start the development server for opera extension
yarn run build:chrome to build chrome extension
yarn run build:firefox to build firefox addon
yarn run build:opera to build opera extension
yarn run build builds and packs extensions all at once to extension/ directory

Development

yarn install to install dependencies.

To watch file changes in development

Chrome
    yarn run dev:chrome
Firefox
    yarn run dev:firefox
Opera
    yarn run dev:opera

Load extension in browser Chrome

Go to the browser address bar and type chrome://extensions
Check the Developer Mode button to enable it.
Click on the Load Unpacked Extension… button.
Select your extension’s extracted directory.

Firefox

Load the Add-on via about:debugging as temporary Add-on.
Choose the manifest.json file in the extracted directory

Opera

    Load the extension via opera:extensions
    Check the Developer Mode and load as unpacked from extension’s extracted directory.

Production

yarn run build builds the extension for all the browsers to extension/BROWSER directory respectively.

Note: By default the manifest.json is set with version 0.0.0. The webpack loader will update the version in the build with that of the package.json version. In order to release a new version, update version in package.json and run script. Running E2E Test The chrome e2e test can be ran with yarn test:e2e:chrome. But are only compatible if you have Chrome v79 installed. Update the chrome driver page to match your chrome install to run the e2e test on a newer version of Chrome.