Code Monkey home page Code Monkey logo

wikitree-sourcer's Introduction

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.

wikitree-sourcer's People

Contributors

colint152 avatar pewu avatar robpavey avatar savannaking avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.