Skip to content
Subscription Score browser extension
JavaScript CSS HTML Shell
Branch: master
Clone or download

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/workflows 💚 added artifacts to build Feb 5, 2020
assets create native popup options Feb 2, 2020
scripts 💚 added artifacts to build Feb 5, 2020
src Merge branch 'master' of github.com:subscriptionscore/extension Feb 23, 2020
store-assets/chrome 🚚 Updated store assets Feb 7, 2020
tests/blocking 👾 made form submit logic cleverer Jan 28, 2020
.babelrc chore: webpack + react + chrome extension setup Dec 5, 2019
.env.default 🏗 create github workflow Jan 9, 2020
.eslintrc feat: firefox build Jan 4, 2020
.gitignore 👾 made form submit logic cleverer Jan 28, 2020
.nvmrc fix: added better load state when options is opened Dec 27, 2019
.prettierignore chore: small tweaks to build Dec 22, 2019
.prettierrc chore: webpack + react + chrome extension setup Dec 5, 2019
LICENCE.md 📝 Add README and LICENCE files Jan 8, 2020
README.md 📝 update README with reproducable build steps Jan 10, 2020
manifest.json Merge branch 'master' of github.com:subscriptionscore/extension Feb 23, 2020
package-lock.json 🔼 added npm package-lock file Jan 10, 2020
package.json 🔖 bumped versions Feb 6, 2020
webpack.chrome.js Merge branch 'fix-form-submit-blocker' into feature-gmail Jan 30, 2020
webpack.config.js 🐛 fixed an issue where forms wouldn't submit Feb 6, 2020
webpack.firefox.js Merge branch 'fix-form-submit-blocker' into feature-gmail Jan 30, 2020
yarn.lock feat: render scores within Gmail inbox Jan 24, 2020

README.md

Subscription Score Extension

This is the code for building the Subscription Score browser extension.

Bugs or Feature requests

Please submit an issue.

Setup

Prerequisites

The extension requires node and npm or yarn to build (tested up to node v12.9.1) and the latest version of Chrome or Firefox to run.

Install dependencies

yarn

or

npm install

Environment

You will need to specify a connection to our API in your .env file. This is the endpoint that the built extension will use to fetch subscription scores.

Currently we don't have a development endpoint, so you will need to use the production one at https://api.leavemealone.app/graphql.

Simply copy the .env.default to use our default envirnoment values.

$ cp .env.default .env

You will also need to purchase an API key in order to make requests.

Build new release

The following command will build for all release targets;

npm run build

Zipped releases can be found in the /releases directory.

Run development version

npm run build:dev <target>

eg. developing Chrome extension;

npm run build:dev chrome

eg. developing Firefox extension;

npm run build:dev firefox

Development manifest.json files can be found in /build/{target} directory.

Usage

Once you've built a version of the extension and installed it into your browser of choice you can connect it to our API. You will still need a valid licence key in order to connect. You can buy a key from our website, or contact us for a development key.

TODO

  • Set up test environment for development contributions.

API Key

An API key is required to run the extension and make requests to the API, you can purchase a key from our website, or contact us for a development key.

Licence

GNU General Public License v3.0

Contact

hi@subscriptionscore.com

You can’t perform that action at this time.