README.md

_{Built with ❤︎ by Navendu, Yegor and the community!}

---

A browser extension that blocks NSFW images from the web pages that you load using TensorFlowJS.

This extension does NOT collect/send any user data. All the operations on the images are done locally on the browser. No user data is being sent to a server for processing.

When a web page is loaded, all the images remain hidden until they are found to be NSFW or not. If they are found to be NSFW, they remain hidden. Otherwise, they become visible.

It is free and is currently supported on Google Chrome and is featured on the Chrome Webstore. We are working on porting this to Safari also (we need help!).

Download for Chrome

Read about the release in Hacker Noon or in Towards Data Science.

Model used - nsfwjs developed by Infinite Red, Inc.

Storing settings - reduxed-chrome-storage

Reach out to us! Join the Slack channel.

Table of contents

• Table of contents
• Usage
• Development
  • Adding to Chrome
• Contribute

Usage

After adding the extension to your browser, it will light-up every time you load a compatible website.

When a page is loaded, the extension would hide all the images in the page and only show images that have been classified as NOT NSFW.

You can toggle(off/on) the extension from the chrome://extensions page in Chrome.

Open the popup window to change NSFW Filter settings.

Development

Clone this repository and navigate inside the project folder and install the dependencies by running:

npm ci

After installing the dependencies, build the project by executing:

npm run build

Run the tests

npm run test

Adding to Chrome

To install the developer version follow the steps below. To just use the extension download from chrome.google.com/webstore/nsfw-filter.

To run development version in clean environment use command:

npm run dev:chrome

Or open Google Chrome and open the Extension Management page by navigating to chrome://extensions or by opening Settings and clicking Extensions from the bottom left.

Enable Developer Mode by clicking the toggle switch next to Developer mode.

Click the "Load Unpacked" button and select the extension directory(.../dist).

Voila! The extension is now installed and ready to be used!

Contribute

Please check the Contributing Guidelines before contributing.

Thanks goes to these wonderful people (emoji key):

Yegor <3 💻 🎨 🤔	Navendu Pottekkat 💻 🖋 📖 🎨 🤔	anonacc 🐛	Abhiram V V 💻 🐛 🤔	yxlin118 🐛 🤔	Clay McGinnis 👀	Brady Dowling 🤔
Mike Crittenden 📖	garfieldbanks 🐛	Titus Roby K 🐛	Haitam 🐛	lizhendong128 🐛	Woctor-Dho 🤔	miaokun-normal 🐛
Christopher Bradshaw 🐛	wingman-jr-addon 🤔	Sagar paul 📖	Rasul 🐛 💻	Aldulkadir Beceri 🐛	silloi 🤔 🐛 💻

This project follows the all-contributors specification. Contributions of any kind welcome!