Skip to content

This is a simple web extension for learning purpose. How to develop, test, package and publish cross-browser extensions.

License

Notifications You must be signed in to change notification settings

jloehel/simple-web-extension

Repository files navigation

logo

simple-web-extension

License: MIT

This is a simple web extension for learning purpose. How to develop, test, package and publish cross-browser extensions.

What is a web extension

Extensions can extend and modify the capability of a browser. This extension is built using the WebExtensions API, a cross-browser system for developing extensions.

Supported browsers

  • Firefox
  • Microsoft Edge
  • Chromium
  • Opera

Dependencies

You need npm or yarn to build the plugin.

Create the dev/test/build environment

$ # Run npm install
$ make init

How to build the extension

The extension can be build by webpack and uses the webpack-webextension-plugin.

$ # Run webpack on your code and create the needed files in the folder addon.
$ make source-build

How to test the extension

Manually

You always can try to load the extension manually in the browser of your choice. You can use web-ext to load the extension for tesing.

Firefox

$ make moz-run

Chromium

$ make chrome-run

Automated

https://github.com/mdn/webextensions-examples/tree/master/mocha-client-tests

How to publish the extension

TODO

How to install the extension

TODO

About

This is a simple web extension for learning purpose. How to develop, test, package and publish cross-browser extensions.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published