/discussify-browser-extension

Discussify's browser extension app

Primary LanguageJavaScriptMIT LicenseMIT

@discussify/browser-extension

Discussify's browser extension.

Screenshot

Installation

Choose one of the installations below. Note that you will need to have a self-sovereign identity on uPort to sign in into the app.

Pre-alpha

Because the current version is a pre-alpha, it's not yet available through the regular Chrome Web store. Follow these steps to install the extension locally:

  1. Download the ZIP file from https://ipfs.io/ipfs/QmUy13FyGqfsmxy7dwiHLtkMYwLaJf2XBfWBkdn6pxM8bn

  2. Extract the ZIP file to a folder

  3. Go to chrome://extensions in Chrome, enable "Developer Mode" and click "Load Unpacked"

  4. Point to the folder where you extracted the ZIP contents

The extension should now appear in the extensions list!

Development

Follow these step to install the extension locally for development:

  1. Clone the project

  2. Install the dependencies by running npm install in the project folder

  3. Start the development process by running npm start in the project folder

  4. Go to chrome://extensions in Chrome, enable "Developer Mode" and click "Load Unpacked"

  5. Install the extension manually in Chrome/Firefox

  6. Point to the dist folder of the project folder

The extension should now appear in the extensions list! Any changes to the source code will be compiled and the extension should automatically reload, thanks to webpack-chrome-extension-reloader. If you have any problems with this feature, simply click the reload button on the extension.

Commands

start

$ npm start

Starts the project for development.

If this is your first time running the project, please go to chrome://extensions in Chrome. Click the "Load Unpacked" button and point to the dist/ folder of this project. The extension should now appear in the extensions list!

Any changes to the source code will be compiled and the extension should automatically reload, thanks to webpack-chrome-extension-reloader. If you have any problems with this feature, simply click the reload button on the extension.

build

$ npm run build

Builds the project for production.

test

$ npm test

Runs the project tests.

lint

$ npm run lint

Checks if the project has any linting errors.

Contributing

If you want to contribute for the project, we encourage you to read over the pm-discussify repository README.