Code Monkey home page Code Monkey logo

adguardbrowserextension's Introduction

AdGuard Browser Extension Build Status

Disclaimer

  • AdGuard Browser Extension is free. We believe that all free products should be open source, and AdGuard Browser Extension is not an exception. Its code can be found in this repository.
  • Privacy policy: https://adguard.com/privacy/browser-extension.html (Briefly: AdGuard sends only necessary, limited information, e.g. information required for filter updates).

AdGuard is a fast and lightweight ad blocking browser extension that effectively blocks all types of ads on all web pages. Unlike its standalone counterparts (AG for Windows, Mac), browser extension is completely free and open source.

To get more information and to download AdGuard Browser Extension, visit our website https://adguard.com/.

How to report an issue?

GitHub can be used to report a bug or to submit a feature request. To do so, go to this page and click the New issue button.

Note: for the filter-related issues (missed ads, false positives etc.) use the dedicated repository.

Our plans

To see the 'big picture', to watch current progress and to get an idea of approximate dates for upcoming AdGuard Browser Extension releases, see this page: https://github.com/AdguardTeam/AdguardBrowserExtension/milestones

Releases

You can find all AdGuard Browser Extension releases here: https://github.com/AdguardTeam/AdguardBrowserExtension/releases

How to become a beta tester?

You can get a beta version of AdGuard Browser Extension for any browser. All necessary information on this topic can be found on a dedicated page.

How to build

Requirements

Install local dependencies by runnning:

  yarn install

Download localizations

To run the task of downloading the localization files, put the oneskyapp.json configuration file in the root directory.

The configuration file looks like:

{
    "url": "url of localizations",
    "project_id": "some id",
    "secret_key": "some key",
    "api_key": "some api key"
}

For security reasons, this file is ignored by .gitignore settings.

To download and append localizations run:

  yarn locales-download

To upload new phrases to oneskyapp you need the same file oneskyapp.json and file with phrases ./Extension/_locales/en/messages.json. Then run:

  yarn locales-upload

Building the dev version

Run the following command:

  yarn dev

This will create a Build directory with unpacked extensions for all browsers:

  Build/chrome-$currentVersion
  Build/firefox-$currentVersion
  Build/opera-$currentVersion
  Build/safari-$currentVersion.safariextension

Building the beta and release versions

Before building the release version, you should manually download necessary resources: filters and public suffix list.

  yarn resources
  yarn beta
  yarn release

You will need to put certificate.pem file to the Compiler directory. This build will create unpacked extensions and then pack them (crx for Chrome, xpi for Firefox).

How to run tests

  yarn test

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.