/browser-extension-boilerplate

A boilerplate template for building cross browser extensions (Chrome and Firefox).

Primary LanguageJavaScriptMIT LicenseMIT

Cross-browser Extension Boilerplate Travis status Licence

A boilerplate template for building cross-browser extensions for Chrome and Firefox. The idea here is make easier to start a great extension for Chrome and Firefox. This template allow you start your cross-brwser extension fast and also work with a organized code structure.

Starting:

  • Open the manifestet.json file and change the matches URL to match exactly with the URL you want you script load.
  • You can add more than one URL at the same time, or add a Regex rule, like:
"matches": ["https://any-url.com/*"],

Locales:

  • You are able to translate your extension, just go to the _locales folder and create the respective language folder.
  • This boilerplate starts with two folder examples, like en to English (as default language) and pt to Portuguese.
  • After create the new language folder, you must create a messages.json file and insert inside:
{
  "keyName": {
    "message": "Value translatable",
    "description": "Description of translatable value"
  }
}

Handler:

  • Your script that will handle the page or tab should be inserted inside the main.js file.

Installing (Chrome)

  1. Visit chrome://extensions/ in Chrome;
  2. Enable the Developer mode;
  3. Click on Load unpacked extension;
  4. Select the folder browser-extension-boilerplate or the folder name you changed.