https://github.com/lfilho/sample-webextension

Test project developing a browser extension with WebExtension APIs.
https://github.com/lfilho/sample-webextension

browser-extension webext webextension webextension-api webextensions

Last synced: about 2 months ago
JSON representation

Test project developing a browser extension with WebExtension APIs.

• Host: GitHub
• URL: https://github.com/lfilho/sample-webextension
• Owner: lfilho
• Created: 2020-05-25T16:49:56.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2023-01-06T19:08:37.000Z (over 2 years ago)
• Last Synced: 2025-04-04T07:06:23.868Z (about 2 months ago)
• Topics: browser-extension, webext, webextension, webextension-api, webextensions
• Language: JavaScript
• Homepage:
• Size: 2.45 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 41
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
![Tests](https://github.com/lfilho/sample-webextension/workflows/Tests/badge.svg)

[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)

[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org)

## 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](/docs/development/TESTING.md)_.

## Development details

Head over to [development docs](/docs/development/) folder for more details and rationale around:

- **[README.md](/docs/development/):** development environment, CI, tools and libraries being used for development. _Here be dragons._

- **[TESTING.md](/docs/development/TESTING.md):** testing examples, strategies and constraints.

- **[RELEASES.md](/docs/development/RELEASES.md):** how and when we release a new version of the extension.

- **[ARCHITECTURE.md](/docs/development/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](/__tests__/shared/test_page.html) loaded. That page will tell you if the extension is working or not: