RobPavey / wikitree-sourcer

The WikiTree Sourcer extension helps wikitree.com users find and cite sources

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

README file for the wikitree-sourcer project

This is the development project for the WikiTree Sourcer browser extension. WikiTree Sourcer helps contributors to wikitree.com search for sources and cite them, thus saving a lot of time and manual typing. It also helps create household tables and in adding new profiles to wikitree from other web sites.

More info on the extension is on the WikiTree Free Space Page here: https://www.wikitree.com/wiki/Space:WikiTree_Sourcer

The top level folder is can be named whetever you like but wikitree-sourcer is the convention. This folder includes the unit tests and other files that are not part of the shipping extension.

The sub-folder "extension" is the extension itself.

Development environment

The extension is being developed by Rob using VSCode on Mac but any editor and platform that supports javascript development can be used.

git and github are used for version control.

Node.js is used for the unit test environment, this requires installing Node.js and some packages.

Xcode is required to test and run the Safari version of the extension.

The extension uses manifest version 3 (MV3) for Chrome and manifest version 2 (MV2) for Firefox and Safari.

The Google Javascript Style Guide is the guide used for formatting/coding standards.

Platform support

There are three variants of the extension:

  • Chrome, this is the main development version
  • Firefox, there is a separate folder browser_variants/firefox. The only file that is different is the manifest
  • Safari, there is an App that points to the same extension source as the Chrome version. Except for the manifest file which is different.

About

The WikiTree Sourcer extension helps wikitree.com users find and cite sources

License:MIT License


Languages

Language:HTML 94.4%Language:JavaScript 5.6%Language:CSS 0.0%Language:Swift 0.0%Language:Shell 0.0%