Vibe Check is a JavaScript-based tool designed to automatically detect and remove abusive or inappropriate content from web pages. By analyzing the text content of a webpage's body, it leverages the ParallelDots Abuse API to identify and clear offensive language, ensuring a safer and more positive browsing experience.
- Automated Content Filtering: Scans and processes all text nodes within a webpage to detect abusive content.
- Real-Time Detection: Utilizes the ParallelDots Abuse API to analyze text in real-time.
- Seamless Integration: Easily integrates into existing web projects or browser extensions.
- Configurable Sensitivity: Adjust the threshold for what constitutes abusive content based on your requirements.
- Web Browser: Compatible with modern browsers like Chrome, Firefox, and Edge.
- ParallelDots API Key: Obtain an API key by signing up at ParallelDots.
git clone https://github.com/b0uks/vibe-check.git
cd vibe-checkInsert the Script into Your Project
Copy the vibe-check.js file into your project directory.
Include the Script in Your HTML
Add the following script tag to your HTML file, preferably before the closing tag:
<script src="path/to/vibe-check.js"></script>Configure the API Key
Replace the placeholder API key in the script with your actual ParallelDots API key:
let params = 'text=' + encodeURIComponent(txt) + '&api_key=YOUR_PARALLELDOTS_API_KEY';⚙️ Usage Once integrated, the script will automatically scan the text content of the webpage's body and remove any content flagged as abusive based on the defined threshold.
How It Works Deep Text Extraction: The deepText function recursively traverses the DOM to collect all text nodes within the tag. Abuse Detection: For each text node, the script sends the text to the ParallelDots Abuse API. Content Removal: If the API response indicates that the text is abusive (i.e., response['abusive'] > 0.5), the script clears the content of that text node. Example
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>Vibe Check Example</title>
</head>
<body>
<p>This is a sample paragraph.</p>
<p>This text contains abusive language.</p>
<script src="vibe-check.js"></script>
</body>
</html>In the above example, any paragraph containing abusive language will be cleared automatically upon page load.
vibe-check/
├── vibe-check.js
├── README.md
└── LICENSEvibe-check.js: Main JavaScript file containing the content filtering logic. README.md: Project documentation. LICENSE: Licensing information.
To ensure the script works as expected:
- Open the HTML File
Load your HTML file in a web browser.
- Check the Console
Open the browser's developer console to view logs related to API responses and content removal actions.
- Verify Content Removal
Inspect the webpage to confirm that abusive content has been cleared.