https://github.com/mozilla/lightbeam-we

Web Extension version of the Firefox Lightbeam add-on
https://github.com/mozilla/lightbeam-we

addon extension firefox-lightbeam mozilla webextension

Last synced: about 12 hours ago
JSON representation

Web Extension version of the Firefox Lightbeam add-on

• Host: GitHub
• URL: https://github.com/mozilla/lightbeam-we
• Owner: mozilla
• License: mpl-2.0
• Created: 2017-04-20T02:55:56.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2023-04-10T13:44:34.000Z (over 1 year ago)
• Last Synced: 2024-05-22T19:59:51.041Z (4 months ago)
• Topics: addon, extension, firefox-lightbeam, mozilla, webextension
• Language: JavaScript
• Homepage: https://addons.mozilla.org/en-GB/firefox/addon/lightbeam/
• Size: 2.87 MB
• Stars: 177
• Watchers: 22
• Forks: 61
• Open Issues: 63
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• awesome-privacy - Lightbeam - firefox] \ [Source][lightbeam-source] (Browser Extensions / Notable Mentions)
• awesome-privacy - Lightbeam - firefox] \ [Source][lightbeam-source] (Browser Extensions / Notable Mentions)

README

        
# Firefox Lightbeam

This is the web extension version of the Firefox Lightbeam add-on for visualizing HTTP requests between websites in real time.

The Firefox Lightbeam extension by Mozilla is a key tool for Mozilla to educate the public about privacy.

![lightbeam-screenshot](/docs/images/lightbeam.gif)

## Quick Start

### Clone the repository

**Note** This repository uses a [submodule](https://github.com/mozilla-services/shavar-prod-lists) to allow some third party requests. To ensure the submodule is cloned along with this repository, use a modified `clone` command:

`git clone --recursive https://github.com/mozilla/lightbeam-we.git`

### Run the web extension

There are a couple ways to try out this web extension:

1. Open Firefox and load `about:debugging` in the URL bar.

    - Click the [Load Temporary Add-on](https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Temporary_Installation_in_Firefox) button and select the `manifest.json` file within the directory of this repository.

    - You should now see the Lightbeam icon on the top right bar of the browser.

    - Click the Lightbeam icon to launch the web extension.

2. Install the [web-ext](https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Getting_started_with_web-ext) tool, change into the `src` directory of this repository, and type `web-ext run`.

    - This will launch Firefox and install the extension automatically.

    - This tool gives you some additional development features such as [automatic reloading](https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Getting_started_with_web-ext#Automatic_extension_reloading).

## Development Guide

### Download dependencies

Run `npm run build`.

### Update the submodule

To manually update the submodule at any time during development, run `git submodule update`.

### Testing

Run `npm run test` to check that everything is OK.

* If you have installed `eslint` globally, you will have to install globally the following `eslint` plugins too:

    - `eslint-plugin-json`

    - `eslint-plugin-mocha`

* Test suites include lint and unit testing. You can individually run lint or unit tests using the following commands:

    * `npm run lint:eslint`

    * `npm run test:karma`

Eslint is used for linting. Karma, Mocha & Chai are used for unit testing. Additionally the test suites are run on the Travis service providing continuous integration support.