/wikitree-browser-extension

Browser extension that adds advanced features to WikiTree.com.

Primary LanguageJavaScriptMIT LicenseMIT

WikiTree Browser Extension

Build and test Build and test

Installation for testers

To test the extension you can:

  • download the latest wikitree-browser-extension.zip,
  • unpack it somewhere on your computer,
  • Go to chrome://extensions,
  • Make sure you have Developer mode turned on (top right corner),
  • Click Load unpacked,
  • Select the folder where you unpacked the extension.
  • then first thing is to go to the extension Options and select which components you want to use.

Installation for developers

To use the latest browser extension from source code, you need to perform several steps to get the source code and build the extension.

  1. Get the source code
git clone https://github.com/wikitree/wikitree-browser-extension.git
cd wikitree-browser-extension
  1. Install npm

See npm official documentation.

  1. Install dependencies
npm install
  1. Build the extension

For Chrome:

npm run build

For Firefox:

npm run build-firefox
  1. Load the extension

For Chrome:

  • Go to chrome://extensions
  • Make sure you have Developer mode turned on (top right corner)
  • Click Load unpacked
  • Select the wikitree-browser-extension/dist folder

For Firefox:

  • Go to about:debugging
  • Click "This Firefox" on the left-hand side
  • Click the "Load Temporary Add-on..." button
  • Choose a file in the wikitree-browser-extension/dist folder

Features

For a full list of features, visit the WikiTree Browser Extension page on WikiTree.

If you would like to contribute, see contributing.md.

If you have an idea for a new feature, post in WikiTree G2G using the wt_apps and improvements tags.