/impulse-blocker

Block distracting websites when you are browsing the web. Use for procrastination.

Primary LanguageJavaScriptMIT LicenseMIT

Impulse Blocker

Block distracting websites when you are browsing the web. Written using WebExtensions so it will be compatible with the future releases of Firefox.

Installation and Usage

If you want to install and use the extension please head over to here.

Simple usage guide can be found here.

Building

If you want to build the extension yourself using the source code, follow these steps.

Dependencies

Make sure you have node (version 11) and npm (version 6) installed on your machine. After you make sure you have npm install web-ext. web-ext is a tool released by Mozilla to help developing WebExtensions.

Install web-ext using this command:

npm install --global web-ext

Then clone this repository:

git clone https://github.com/raicem/impulse-blocker.git

Then install the dependencies using npm

npm install

If you want to build it to sideload the extension without using the Mozilla's AMO use this command.

npm run release

This will create a zip file in the web-ext-artifacts folder. This file contains everyting the Firefox needs to run the extenison. You can install it following instructions here and here.

Again just a reminder, you can install the extension from the official add-ons page. Simple usage instructions are here.

Contributing

The extenison is open for any kinds of contribution. Please note that it requires a basic knowledge about WebExtensions API and React.

After following the steps explained in the Building section above, all you have to do is run these commands in parallel.

npm run watch will start the Webpack watcher. This will immediately build the extension and create files to be loaded into the Firefox.

npm run browser will load the built files into the isolated Firefox instance and you will be able to see the changes you make immediately.

Contributors

Many to thanks to Crote and pkonneker for their contributions.