Giter VIP home page Giter VIP logo

tihawk / browser-extension-boilerplate Goto Github PK

View Code? Open in Web Editor NEW
0.0 1.0 0.0 325 KB

A TypeScript boilerplate for writing browser extensions for Chrome, Firefox and Edge. Uses webpack to build the finished source.

License: MIT License

TypeScript 55.54% JavaScript 36.86% HTML 7.59%
boilerplate chrome-extension chrome-extension-starter edge-extension firefox-addon firefox-extension polyfill template template-repository typescript

browser-extension-boilerplate's Introduction

Boilerplate for Web-Extensions

GitHub package.json dependency version (dev dep on branch) GitHub package.json dependency version (dev dep on branch) GitHub package.json dependency version (dev dep on branch)

A TypeScript boilerplate for writing browser extensions for Chrome, Firefox and Edge. Uses webpack to build the finished source.

Building

The extension can be built for one of the following browsers at a time: Chrome, Firefox, Edge.

  1. First time after cloning, run npm install
  2. Run npm run build:<browser> where <browser> can be chrome|firefox|edge

The bundled files will be located in the dist/ directory.

Loading into the browser

After having built the extension for the desired browser, you can run it following the appropriate steps.

Chrome

  1. Navigate to chrome://extensions/
  2. Switch to Developer Mode
  3. Load extension by clicking Load unpacked and navigating to the dist/ directory

Firefox

Method 1.

  1. Run in firefox with npm run start:firefox

Method 2.

  1. Navigate to about:debugging#/runtime/this-firefox
  2. Load extension by clicking Load Temporary Add-on and navigating to the dist/ directory

Edge

  1. Navigate to edge://extensions/
  2. Switch to Developer Mode
  3. Load extension by clicking Load unpacked and navigating to the dist/ directory

Licence

browser-extension-boilerplate's People

Contributors

tihawk avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.