Extension Boilerplate

screenshot of Extension Boilerplate

A template for building cross browser extensions for Chrome, Opera & Firefox.

Overview:

The project mentioned in this document is a browser extension/addon that can be used on multiple browsers, including Chrome, Opera, and Firefox. The extension serves as a starting point for building browser extensions and is specifically extracted from the browser extensions built for the side-project, Email This. Email This is an alternative to bookmarking tools like Pocket, Readability, and Instapaper, where it removes ads and distractions from an article and sends the user a simplified email with only the text and images. The extension does not require any additional applications or logins.

Features:

  • Support for multiple browsers: The extension can be used on Chrome, Opera, and Firefox browsers.
  • Simpler alternative to bookmarking tools: Provides a simplified way to save articles without ads and distractions through email.
  • Easy installation: Can be easily installed by cloning the repository and running the necessary commands.
  • Live reload for development: Enables live reload functionality for developers working on the extension.

Load the extension in Chrome & Opera:

  1. Open the Chrome or Opera browser and navigate to chrome://extensions.
  2. Select "Developer Mode" and click on "Load unpacked extension...".
  3. From the file browser, choose the extension-boilerplate/build/chrome or extension-boilerplate/build/opera directory.
  4. The extension will be loaded in the browser.

Load the extension in Firefox:

  1. Open the Firefox browser and navigate to about:debugging.
  2. Click on "Load Temporary Add-on".
  3. From the file browser, choose the extension-boilerplate/build/firefox directory.
  4. The extension will be loaded in Firefox.

Summary:

The project described in this document is a browser extension/addon that can be used on multiple browsers. It is a starting point for building browser extensions and is extracted from the browser extensions built for the Email This side project. The extension offers an alternative to bookmarking tools by removing ads and distractions from articles and sending simplified emails with just the text and images. The installation process involves cloning the repository and running the necessary commands, or downloading the pre-built sample extension files. The extension supports live reload for developers and is under the MIT license.

gulp
Gulp

Gulp.js is an old but popular site building tool that automates various repetitive development tasks in web development, such as compiling Sass, minifying JavaScript, and optimizing images.