Skip to content

Latest commit

 

History

History
57 lines (40 loc) · 2.24 KB

README.md

File metadata and controls

57 lines (40 loc) · 2.24 KB

Crypto Tab Logo
Crypto Tab

Browser extension that replaces your New Tab page with a Bitcoin price chart:

Crypto Tab preview

📦 Install

👍 Contributing

I'm open to ideas and suggestions! If you want to contribute or simply you've caught a bug - you can either open an issue or clone the repository, and fire a Pull Request.

Its a single code base website and new tab (cross-)browser extension.

To install the project, first make sure you have NodeJS and NPM installed. Preferably, the latest versions, but anything not extremely old should work too. Then, simply run npm install. Then:

  1. To build the extension distribution files, run:

    npm run build:extension
  2. To build the extension distribution files and re-build (watch) in case of changes, run:

    npm run build:extension:watch
  3. To build the website distribution files, run:

    npm run build:website
  4. To build the website distribution files and re-build (watch) in case of changes, run:

    npm run build:extension:watch

Finally, load the extension:

  • In Chrome:

    • Navigate to chrome://extensions
    • Select "Developer Mode" and then click "Load unpacked extension..."
    • From the file browser, choose the dist/extension/ directory
  • In Firefox:

    • Navigate to about:debugging
    • Click "Load Temporary Add-on" and from the file browser, choose the manifest.json file in the dist/extension/ directory

🚔 License

The code and the documentation are released under the GPL-3.0 License.