CleanSurf

University of Illinois

CleanSurf it is a web extension that allows for seamless filtering of explicit content to prevent such interactions and create a better overall browsing experience. The extension has a control panel where users can toggle the filter on and off, select how strict they want the filter to be, choose what type of content they want to filter, and customize the filter.

Developed With

  • Python
  • Django
  • JavaScript
  • Google Chrome extension API
  • TensorFlow
  • NudeNet

Installation

Clone the Repository

git clone https://github.com/CS222-UIUC/course-project-group-1.git

Install the API Dependencies

Make sure you have Python 3.9 or higher installed to run the Flask API. Then, install the dependencies using the following command:

pip install -r ./api/requirements.txt

Make sure you have a chromium based browser installed.

Install NudeNet Models

Models are located under the 'models' directory. To install the models, run the following command:

python ./api/models/model_installer.py

Usage

Run the Server

python api/api.py

Note that the server is using port 5000 by default. If you want to change the port, you can do so by editing the api/api.py file.

Load the Extension

  1. On your browser, go to chrome://extensions/
  2. Enable developer mode by toggling the switch in the top right corner (left panel if you are using Edge)
  3. Click on the Load unpacked button
  4. Navigate to the extension directory and select it
  5. Make sure the extension is enabled

Use the Extension

  1. Navigate to any website
  2. Click on the extension icon
  3. Toggle the filter on by pressing the CLEAN button