/heutagogy-chrome-extension

Primary LanguageJavaScriptGNU Affero General Public License v3.0AGPL-3.0

Heutagogy

Heutagogy chrome extension project.

Install

Install extension from Chrome Web Store: Heutagogy

Features

Examples

Window

The context menu is created by chrome/extension/background/contextMenus.js.

Preparing

# clone it
$ git clone https://github.com/heutagogy/heutagogy-chrome-extension

# Install dependencies
$ npm install

Development

  • Run script
# build files to './dev'
# start webpack development server
$ npm run dev

React/Redux hot reload

This uses Webpack and react-transform, and use Redux. You can hot reload by editing related files of Popup & Window page.

Using Redux DevTools Extension

You can use redux-devtools-extension on development mode.

Build

# build files to './build'
$ npm run build

Compress

# generate crx and xml files
$ npm run build
$ npm run compress

Options

To build crx file (auto update), please set options in compress.config.js, and add update.xml file url in [manifest.json](https://developer.chrome.com/extensions/autoupdate#update_url manifest.json).

  • keyFile: your private key path you can use npm run compress-keygen to generate private key ./key.pem
  • contentPath
  • name: name of crx file
  • outputPath: path to desired crx and xml files
  • updateFilename: name of update xml file
  • updateUrl

See autoupdate guide for more information.

Test

  • test/app: React components, Redux actions & reducers tests
# lint
$ npm run lint
# test/app
$ npm test
$ npm test -- --watch  # watch files

LICENSE

AGPLv3