Skip to content

Latest commit

 

History

History

browser-extension

README.md

Tournesol browser extension

The extension adds several Tournesol features to the YouTube interface.

Users can directly access the comparison and analysis pages of videos, and can easily add them to their rate-later list.

Install on Mozilla Firefox 🌻 Install on Chrome

Table of Content

Development guidelines

This section contains the development documentations, and the contributing guidelines we would like every contributor to follow.

Documentation

The documentations for developing and distributing web extensions are available here:

Install the development tools

yarn install

Prepare the extension

Before loading the extension into your browser, you need to run yarn configure. It will generate manifest.json, config.js and the import wrappers (small scripts that allow us to use ECMAScript modules in content scripts).

By default, the script creates an extension that connects to the production Tournesol website. If you want to connect to your development servers, you can run yarn configure:dev instead.

Code Quality

We use ESLint to find and fix problems in the JavaScript code.

Before submitting new pull requests, run the linter with the following commands:

yarn lint

# automatically fix problems
yarn lint --fix

Updating the version

This project adheres to Semantic Versioning.

Given a version number MAJOR.MINOR.PATCH, increment the:

  • MAJOR version when backwards incompatible changes are made
  • MINOR version when new backwards compatible functionalities are added
  • PATCH version for backwards compatible bug fixes

Release a new version

To release the extension on Chrome or Mozilla Firefox, run the script ./build.sh and upload the generated .zip file in the corresponding extension web store.

Copyright & License

Copyright 2021-2022 Association Tournesol and contributors.

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published
by the Free Software Foundation, either version 3 of the License, or
any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.

Included license: