Skip to content

lanchana/bitpay-browser-extension

 
 

Repository files navigation

Pay with BitPay • Browser Extension

Be alerted whenever a website you visit offers BitPay as a payment option.


Browser Support

Chrome Firefox Opera Edge Yandex Brave vivaldi
49 & later ✔ 52 & later ✔ 36 & later ✔ 79 & later ✔ Latest ✔ Latest ✔ Latest ✔

🚀 Quick Start

Ensure you have

  • Node.js 10 or later installed
  • Yarn v1 or v2 installed

Then run the following:

  • yarn install to install dependencies.
  • yarn run dev:chrome to start the development server for chrome extension
  • yarn run dev:firefox to start the development server for firefox addon
  • yarn run dev:opera to start the development server for opera extension
  • yarn run build:chrome to build chrome extension
  • yarn run build:firefox to build firefox addon
  • yarn run build:opera to build opera extension
  • yarn run build builds and packs extensions all at once to extension/ directory

Development

  • yarn install to install dependencies.

  • To watch file changes in developement

    • Chrome
      • yarn run dev:chrome
    • Firefox
      • yarn run dev:firefox
    • Opera
      • yarn run dev:opera
  • Load extension in browser

    • Chrome

      • Go to the browser address bar and type chrome://extensions
      • Check the Developer Mode button to enable it.
      • Click on the Load Unpacked Extension… button.
      • Select your extension’s extracted directory.
    • Firefox

      • Load the Add-on via about:debugging as temporary Add-on.
      • Choose the manifest.json file in the extracted directory
    • Opera

      • Load the extension via opera:extensions
      • Check the Developer Mode and load as unpacked from extension’s extracted directory.

Enabling testnet payments

Change your .env.development file to the following:

API_ORIGIN=https://test.bitpay.com

Generating browser specific manifest.json

Update src/manifest/index.js file with browser vendor prefixed manifest keys

{
  "__chrome__name": "SuperChrome",
  "__firefox__name": "SuperFox",
  "__edge__name": "SuperEdge",
  "__opera__name": "SuperOpera"
}

if the vendor is chrome this compiles to:

{
  "name": "SuperChrome",
}

Add keys to multiple vendors by seperating them with | in the prefix

{
  __chrome|opera__name: "SuperBlink"
}

if the vendor is chrome or opera, this compiles to:

{
  "name": "SuperBlink"
}

See the original README of wext-manifest package for more details

Production

  • yarn run build builds the extension for all the browsers to extension/BROWSER directory respectively.

Show your support

Give a ⭐️ if this project helped you!

Licence

Code released under the MIT License.

About

BitPay Browser Extension

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 82.8%
  • CSS 13.5%
  • JavaScript 3.5%
  • HTML 0.2%