An open API service indexing awesome lists of open source software.

https://github.com/webexp0528/auto-ad-viewing-chrome-extension


https://github.com/webexp0528/auto-ad-viewing-chrome-extension

Last synced: 28 days ago
JSON representation

Awesome Lists containing this project

README

          



Auto AD Viewer


Works for Chrome, Opera, Edge & Firefox.


## Features


Write in your favourite framework - React! :)


Now you can create part of your exstensions in React framework - as you wish ;)


Write once and deploy to Chrome, Opera, Edge & Firefox


Based on WebExtensions. It also includes a tiny polyfill to bring uniformity to the APIs exposed by different browsers.


Live-reload


Your changes to CSS, HTML & JS files will be relayed instantly without having to manually reload the extension. This ends up saving a lot of time and improving the developer experience. Based on https://github.com/xpl/crx-hotreload


Newest js technology stack


You can use ES6, ES5.


Comfortable styles import


With react you can loas styles directy and you can use scss for styling.


Easily configurable and extendable


Project use webpack so you can easly customize your project depends on your needs. In config.json you can define source path for each browser (if needed - default it's the same source), destintantion and develop directory.


Clean code


Clean code is the best way for long term support for project. Boilerplate has fully configured eslint with airbnb styleguide.


Test your components!


Project use some library which support your testing proces. As test runner we use karma, as testing framework mocha. As support to assertion we use chai.

## Installation

1. Clone the repository `git clone https://github.com/WebExp0528/React-Extension-Boilderplate.git`
2. Run `npm install` or `yarn install`
3. Run `npm run build` or `yarn build`

##### Load the extension in Chrome & Opera

1. Open Chrome/Opera browser and navigate to chrome://extensions
2. Select "Developer Mode" and then click "Load unpacked extension..."
3. From the file browser, choose to `React-Extension-Boilderplate/dev/chrome` or (`React-Extension-Boilderplate/dev/opera`)

##### Load the extension in Firefox

1. Open Firefox browser and navigate to about:debugging
2. Click "Load Temporary Add-on" and from the file browser, choose `React-Extension-Boilderplate/dev/firefox`

##### Load the extension in Edge

https://docs.microsoft.com/en-us/microsoft-edge/extensions/guides/adding-and-removing-extensions

## Developing

The following tasks can be used when you want to start developing the extension and want to enable live reload -

- `npm run watch-dev` or `yarn watch-dev`

## Packaging

Run `npm run build` or `yarn build` to create a zipped, production-ready extension for each browser. You can then upload that to the appstore.

---

This project is licensed under the MIT license.

If you have any questions or comments, please create a new issue. I'd be happy to hear your thoughts.