Profanity Filter Chrome Extension

Blocks unwanted explicit words

Report Bug · Request Feature

Table of Contents

1. About The Project
2. Features
3. Installation
4. Contributing

About The Project

Profanity filter is a fully customizable chrome extension that blocks any explicit content that is present in the web page.

Built With

• TypeScript - Made use of typescript because of the elegant type system it provides, which aids in avoiding silly bugs in terms of passing the wrong data type and also for the code IntelliSense, which makes it easier to work.
• ReactJS - Made use of ReactJS because of the ease of development it provides in making a web app/chrome extension and the performance gains that come out of the box with React because of the use of Virtual DOM.

Features

• Blocks explicit content and replaces the text with a user-defined placeholder.
• Get a detailed report of all the explicit words.
• Add/Remove words to the whitelist and blacklist.
• Customizable placeholder.
• User settings sync across different devices using the same gmail account(if enabled).

Installation

• Clone the project.

• Run yarn install/npm install(depending on your preferred package manager) in the root of the project.

• Run yarn run build/npm run build(depending on your preferred package manager) in the root of the project.

• Copy the generated build folder in the root directory of the project to a destination of your choice.

• Open Google chrome and go the url: chrome://extensions/

• You should see a page like the following:

  

• Enable the devloper mode(if not already)

• Click on load unpacked and select the build folder you copied eariler.

• You should now be able to see the profanity-filter-chrome-extension on the list.

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request