Git Product home page Git Product logo

subscriptionscore's Introduction

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

[email protected]

subscriptionscore's People

Contributors

jivings avatar dinkydani 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.