CRW-Extension

Browser extension that shows a popup and notifications when the site, product, or service you're viewing has an article on the Consumer Rights Wiki.

Install

• Install on Chrome, Edge and Brave https://chromewebstore.google.com/detail/consumer-rights-wiki/bppajinomefndbbmopljhbdfefnefdha
• Install on Firefox https://addons.mozilla.org/firefox/addon/consumer-rights-wiki/

Contributing

Technical Contributions

Contributions are welcome! Please read the CONTRIBUTING.md guide for details on how to ask questions, report bugs, suggest enhancements, and submit Pull Requests.

[!IMPORTANT] Before opening an issue or bug report, please ensure you have read CONTRIBUTING.md carefully. Issues that do not follow the guidelines will be closed without review.

Editorial and Wiki Contributions

The extension matches sites and services against data sourced from the Consumer Rights Wiki. You can contribute in two ways: - Editorial - Help improve or add articles directly on the Consumer Rights Wiki - Cargo data - Help add structured metadata that powers the extension's matching. You can help by contributing data at the Cargo completion project. A daily Cargo report is also available, which tracks data quality and helps ensure the extension's matching is as accurate as possible.

Community & Discussions

Have a question, idea, or just want to connect with other users? Head over to Discussions to get involved.

Development

Clone and build the extension:

Chrome & Firefox

git clone https://github.com/FULU-Foundation/CRW-Extension.git
cd CRW-Extension
npm ci
npm run build

The compiled extension will be output in the dist folder. Alternatively run npm run build:watch and vite will watch for changes and update the extension automatically during development.

Development Installation

For Chrome:

1. Open Extension settings: e.g. chrome://extensions/ or brave://extensions/ etc.
2. Enable Developer Mode
3. Click Load Unpacked
4. Navigate to the unzipped folder.

For Firefox:

1. Open: about:debugging#/runtime/this-firefox
2. Expand 'Temporary Extensions'
3. Click 'Load Temporary Add-on...'
4. Navigate to the unzipped folder and open manifest.json

Formatting

npm run format

Disclaimer

The source code for the CRW Extension is licensed under the MIT License.

All references found by this software are not part of CRW Extension and are provided to the end-user under CC BY-SA 4.0 licensing by the originating site consumerrights.wiki.