lfilho / sample-webextension

Test project developing a browser extension with WebExtension APIs.

What are we solving?

This is a simple browser extension to identify and block trackers around the web. Inspired by DuckDuckGo's and Mozilla's efforts of making a safer and more private web :-)

Installation and tests

1. Ensure you have node >=13.2.0 installed.
2. Clone or download this repo and then run npm install within it.
3. Then you can run npm test to execute the test suite. More details in TESTING.md.

Development details

Head over to development docs folder for more details and rationale around:

• README.md: development environment, CI, tools and libraries being used for development. Here be dragons.
• TESTING.md: testing examples, strategies and constraints.
• RELEASES.md: how and when we release a new version of the extension.
• ARCHITECTURE.md: an overview of our software architecture.

See the extension in action

Run npm run develop. This will open a Firefox instance up with the extension preloaded for you and our test page loaded. That page will tell you if the extension is working or not: