Skip to content

augustofrade/red-it-extension

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

Red-It

Red-It Logo

Block posts on Reddit based on its content

Firefox Compatible Firefox Mobile Compatible Version

Red-It is a Firefox extension designed to enhance your Reddit browsing experience by allowing you to block unwanted posts based on keywords. Take control of your Reddit feed and filter out posts that contain specific words, phrases and simple patterns you'd rather not see.

Recover your sanity while browsing, install it now! on your computer or mobile device!

โœจ Features

  • ๐Ÿšซ Content Blocking: Block Reddit posts containing specific keywords in their title
  • ๐ŸŽฏ Wildcard Support: Use * to match any number of characters (e.g., "red*" blocks both "reddit" and "red-it")
  • โš™๏ธ Easy Configuration: Simple popup interface for quick access
  • ๐Ÿ”„ Real-time Filtering: Content is filtered as you browse without page reloads
  • ๐Ÿ“ Usage Metrics: Find out how many posts and subreddits have been blocked while you browsed
  • ๐Ÿ’พ Persistent Storage: Your settings are saved and synced across browser sessions

๐Ÿ“ฆ Installation

Install it directly on your browser from the Firefox Add-ons store page.

๐Ÿงฐ Usage Screenshots

Popup

Popup that appears on the user's browser when the icon of the extension on the toolbar is clicked.

Extension metrics are displayed here.

Extension Popup

Popup with Menu Open

Extension popup with the "Mode" button focused after being clicked, expanding a submenu with different modes one can choose to hide the content of the page.

Available modes are:

  • Purge: Removes the content from the page as if it wasn't there at all.
  • Cover: Covers the content with a gray placeholder. The content is displayed when being hovered.
  • Hide: Hides the content by making it invisible. Leaves a blank area on its position.
  • Show: Disables the extension and shows all kinds of content without any blocking at all. No metrics aree collected.

The description of each mode is displayed when hovering them.

Extension Popup with Menu Open

Blocked Community Notice

This page is shown when the user tries to visit a community (subreddit) that is in their blocklist.

The only way to stop being shown is to remove the subreddit from the blocklist.

Blocked Community Notice

Dashboard

The dashboard has the following sections and features:

  • Quick Settings

    • Changed the blocking mode of the extension just like in its popup
  • Content Blocking

    • Keyword blocklist
    • Communities/subreddits blocklist
    • Comments blocking settings (toggle and mode)
    • Block premium ads
    • NSFW posts blocking
  • Technical

    • Extension inner workings logging on the console
  • Danger Zone

    • Delete data
    • Reset extension metrics
  • About

Bellow is a portion of the Settings page. To view the complete page, see this screenshot.

Settings Page Screenshot Placeholder

๐Ÿ› ๏ธ Usage

Basic Setup

  1. Install the extension following the installation instructions above
  2. Click the Red-It icon in your Firefox toolbar
  3. Open Settings to configure your blocklist
  4. Add keywords you want to block (one per line)
  5. Browse Reddit and enjoy your filtered experience!

Keyword Syntax

  • Content per line: each line is a different keyword or phrase for the extension to use as filter
  • Exact match: javascript - blocks posts containing "javascript"
  • Wildcard: java* - blocks posts containing "javascript", "java", etc.
  • Case insensitive: All keywords are matched case-insensitively

โ” Permissions

Below are the following permissions the extension requires and what they are used for:

  • Storage: saving and retrieving user-defined rules to block content with.
  • Tabs: opening settings page and displaying blocked subreddit page.
  • WebRequest, WebRequestBlocking: detecting subreddit access to deny access to it in case the subreddit is set by the user to be blocked by the extension.

โ„น๏ธ About

The extension is called "red-it" because the posts were initially hidden by a red rectangle instead of a white or gray one. Even after changing the colors, I liked that the name resembles the target website and also sounds like it blocks its content.

๐Ÿ“ฆ Development/debugging

  1. Clone the repository

    git clone https://github.com/augustofrade/red-it-extension.git
    cd red-it-extension
  2. Load the extension in Firefox

    • Open Firefox and navigate to about:debugging
    • Click "This Firefox" in the sidebar
    • Click "Load Temporary Add-on"
    • Select the src/manifest.json file from the cloned repository

๐Ÿ“ Reporting Issues

Found a bug or have a feature request? Please open an issue with:

  • Clear description of the issue or feature
  • Steps to reproduce (for bugs)
  • Expected vs actual behavior
  • Screenshots if applicable

๐Ÿ“„ License

This project is free software. See the LICENSE file for details.

Source

About

Firefox extension to block content on Reddit: Recover your sanity and enhance your browsing experience!

Topics

Resources

License

Stars

Watchers

Forks