pwyf / iati-decipher

📊 Browser plugins for deciphering IATI organisation files.
https://iati-decipher.publishwhatyoufund.org
MIT License
1 stars 2 forks source link
chrome-extension firefox-extension iati

IATI Decipher GitHub release

Browser plugins for deciphering IATI organisation files.

Installation

Demo

Demo

Development

You’ll need git, as well as recent versions of npm, node and gulp-cli.

$ # clone the repo
$ git clone https://github.com/pwyf/iati-decipher.git
$ cd iati-decipher
$
$ # install dependencies
$ npm install
$
$ # watch for changes & create development build
$ npm run watch

Then:

  1. In Chrome, visit chrome://extensions and enable developer mode.
  2. Click “Load unpacked” and select the dev folder.
  3. Visit any organisation dataset on the IATI registry. E.g. this one.
  4. You might also want to consider installing Extensions Reloader. It’s very handy.

Build for distribution

  1. First, be sure to bump the version number in package.json, src/static/manifest.json, and CHANGELOG.md.

  2. Then run:

    npm run dist

    This should update the files in the docs/demo folder (which are in version control) and create an extension.zip file (which isn’t in version control).

  3. Commit all changes and push to github

  4. Create a new github release:

    npx gh-release
  5. Finally, upload extension.zip to: