Giter VIP home page Giter VIP logo

check-mark's Introduction

Check

Travis

A browser extension for Check.

Browser Extension

Download

Available for Mozilla Firefox and Google Chrome.

Development

The JavaScript code lives in src. Static files like HTML, Manifest and images live in public.

Copy config.js.example to config.js and define your configurations.

You can compile the code with npm run build. It was developed and tested with Node 7. After the code is compiled, it will be under build. After you installed the extension (see below how to do it), you don't need to re-install it when you make code changes.

Running the extension on Google Chrome

Follow the steps below or our video-tutorial.

  • Visit chrome://extensions
  • Enable "Developer mode"
  • Click "Load unpacked extension..."
  • Pick one of the directories:
    • build, if you are a developer and has compiled the extension locally in your machine
    • releases/qa, to use the QA version
    • releases/live, to use the live version
  • The extension will appear on the toolbar

If you are not able to login using the browser extension on Chrome, make sure that the option "Block third-party cookies", under your browser configurations, is disabled. If you use an extension like AdBlock, you first need to disable the extension, then disable the "Block third-party cookies" option.

Running the extension on Mozilla Firefox

  • Visit about:debugging
  • Click "Load Temporary Add-on"
  • Pick the manifest.json file inside one of the following directories:
    • build, if you are a developer and has compiled the extension locally in your machine
    • releases/qa, to use the QA version
    • releases/live, to use the live version
  • The extension will appear on the toolbar

Localization

As usual, localization is done on Transifex. You must have the tx client installed on your computer and configured to communicate with the Transifex server. You can send new strings to Transifex by running npm run transifex:upload and you can download translations from Transifex by running npm run transifex:download.

Testing

  • You need zip, rspec, geckodriver and chromedriver.
  • Copy test/config.yml.example to test/config.yml and adjust the configurations.
  • Tests can be run with npm run test.

Release

  • Edit public/manifest.json and increment the version number
  • Create a new release via npm run release:live which will create the package releases/live/live.zip
  • Submit the package to Chrome Store and Firefox Store for review and publishing

Chrome Store

  • Some permissions will require justification:
    • activeTab: Send the current URL to Check
    • contextMenus: Invoke the extension from a link on right-click

Firefox Store

  • Nothing special is needed, just upload the ZIP

check-mark's People

Contributors

ahmid avatar amoedoamorim avatar caiosba avatar danielafeitosa avatar danielevalverde avatar dariusk avatar dependabot[bot] avatar dgaffney avatar hartsick avatar infojunkie avatar jameszxie avatar mazhang2718 avatar melsawy avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

check-mark's Issues

Login via Check API

Before allowing the user to submit URLs to Check via the extension, they need to login to Check. Display a login dialog that communicates with the Check API to obtain a connection token.

@caiosba plz link to relevant code in bridge-client.

Show URL submission dialog

After user login, the extension should show a dialog that allows the user to submit the current URL to Check. The dialog should show the user's projects on Check, which are all the projects where the user is active. Coordinate with the Meedan dev team to access this API endpoint.

The user can also enter a comment that will be displayed along with the submitted URL. When "Submit" is clicked, the extension calls another API endpoint to perform the actual URL submission. Check API will return a link to the submission on Check: this URL should be displayed as a result message.

@caiosba plz link to relevant code from bridge-client

Deploy Web Extension for Firefox

Recent versions of Firefox support the Web Extension API. Please ensure that the extension here is able to work with those versions of FF.

Extend build system to target a Web Extension

The default build script for React targets a web app. In our case, we want to target a browser plugin, so there should be additional build steps to generate the correct Web Extension structure.

@caiosba, plz add links to relevant parts of the bridge-client source that performs these steps.

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.