Skip to content

README.md

Latest commit

 

History

History
62 lines (42 loc) · 2.02 KB

README.md

File metadata and controls

62 lines (42 loc) · 2.02 KB

GmailJS Node boilerplate

Node.js CI

This repo contains sample code to get a WebExtensions-based browser-extension using the gmail.js library.

Usage

First get the code and build it:

# get code
git clone https://github.com/josteink/gmailjs-node-boilerplate/

# get deps and build
cd gmailjs-node-boilerplate
npm install
# ensure you're running latest version!
npm update
npm run build

Now ensure the code loads and works:

  • Load the folder containing the extension (or manifest.json) in your browser.
  • Load mail.google.com in your browser and open the developer console.

You should be greeted by a message saying the following

Hello, <you>. This is your extension talking!

If that works, you should now be ready to customize the extension-code. Do this by editing extension.js.

You can also interact with a instance of Gmail.js ready for use. gmail should already be exposed in the developer console as a global variable.

You can use this to get familiar with the API.

Cheers!

Regarding WebExtension Manifest versions

Gmail.JS and this boilerplate repo was originally developed when WebExtension Manifest V2 were in place. Thanks to the help of @tomer-regev this boilerplate repo now uses Manifest V3 instead.

If you for whatever reason still want to use the V2 code, check out the code back at ManifestV2-tag, which has been maintained for historical reasons.

Either way, Gmail.JS itself should work fine under both versions with no change required in your extension-code, unless your extension itself has code which needs to be migrated.

For more advice about upgrades, see the Chrome documentation.