Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/nsfw-filter/nsfw-filter

A free, open source, and privacy-focused browser extension to block “not safe for work” content built using TypeScript and TensorFlow.js.
https://github.com/nsfw-filter/nsfw-filter

chrome-extension google-chrome-extension hacktoberfest nsfw-classifier nsfw-detection nsfw-filter nsfw-recognition tensorflow tensorflowjs typescript

Last synced: 3 days ago
JSON representation

A free, open source, and privacy-focused browser extension to block “not safe for work” content built using TypeScript and TensorFlow.js.

Awesome Lists containing this project

README

        

# NSFW Filter

A free, open source, and privacy-focused browser extension to block "not safe for work" content.

Built using TypeScript, TensorFlow.js, and [NSFWJS](https://github.com/infinitered/nsfwjs).

[Download now from chrome web store!](https://chrome.google.com/webstore/detail/nsfw-filter/kmgagnlkckiamnenbpigfaljmanlbbhh)

![Demo of using NSFW Filter](demo/images/demo.gif)

# Table of contents

- [NSFW Filter](#nsfw-filter)
- [Table of contents](#table-of-contents)
- [Usage](#usage)
- [Development](#development)
- [Contribute](#contribute)

# Usage

You can install the extension from the [chrome web store](https://chrome.google.com/webstore/detail/nsfw-filter/kmgagnlkckiamnenbpigfaljmanlbbhh) or [source](#development).

When you load web pages, NSFW Filter will first hide all images and only show those classified as safe.

To customize the extension, click the icon in your extensions tab.

![NSFW Filter popup](demo/images/popup-window.png)

# Development

Install dependencies by running:

```sh
npm install
```

Then build the project:

```sh
npm run build
```

To run the tests:

```sh
npm run test
```

To run a development version with live reload, run:

```sh
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```).

![Load extension to Chrome in developer mode](./demo/images/install-instructions.png)

# Contribute

Please check the [**Contributing Guidelines**](https://github.com/navendu-pottekkat/nsfw-filter/blob/master/.github/markdown/CONTRIBUTING.md) before contributing.

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):



Yegor <3
Yegor <3

💻 🎨 🤔
Navendu Pottekkat
Navendu Pottekkat

💻 🖋 📖 🎨 🤔
anonacc
anonacc

🐛
Abhiram V V
Abhiram V V

💻 🐛 🤔
yxlin118
yxlin118

🐛 🤔
Clay McGinnis
Clay McGinnis

👀
Brady Dowling
Brady Dowling

🤔


Mike Crittenden
Mike Crittenden

📖
garfieldbanks
garfieldbanks

🐛
Titus Roby K
Titus Roby K

🐛
Haitam
Haitam

🐛
lizhendong128
lizhendong128

🐛
Woctor-Dho
Woctor-Dho

🤔
miaokun-normal
miaokun-normal

🐛


Christopher Bradshaw
Christopher Bradshaw

🐛
wingman-jr-addon
wingman-jr-addon

🤔
Sagar paul
Sagar paul

📖
Rasul
Rasul

🐛 💻
Aldulkadir Beceri
Aldulkadir Beceri

🐛
silloi
silloi

🤔 🐛 💻

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!