Blip is a proactive compliance tool designed to help YouTube creators ensure their videos adhere to YouTube’s community guidelines before uploading. With features like keyword flagging, inappropriate visual detection, and automatic video adjustments (bleeping and blurring)(yet to be implemented), Blip aims to streamline content moderation for creators. It's my goodbye to ALX_SE Africa.
- Keyword Flagging: Automatically identifies and flags inappropriate language in audio.
- Visual Content Analysis: Detects inappropriate visuals and overlays blurs where necessary.
- Real-Time Processing: Provides a user-friendly interface for reviewing flagged content.
- Scalable Architecture: Handles large video files and simultaneous users efficiently.
Before setting up the project, ensure you have the following:
- Node.js (v16 or later) installed.
- Google AI Studio API Key for AI integrations.
- MongoDB Atlas Database Key for storing flagged timestamps and user data.
- Redis Server, Bull Queue Requires it.
$ git clone https://github.com/BugFixDotExe/blip.git
$ cd blip
-
Google AI Studio API Key:
- Visit Google AI Studio and create a new project.
- Enable the necessary APIs (e.g., Speech-to-Text, Vision API).
- Generate an API key and note it down.
-
MongoDB Atlas Database Key:
- Sign up or log in to MongoDB Atlas.
- Create a new cluster and get the connection string.
- Replace
<username>
and<password>
with your credentials in the connection string.
Create a .env
file in both the frontend and backend directories:
Backend .env File:
GOOGLE_API_KEY=your-google-api-key
MONGODB_URI=your-mongodb-connection-string
PORT=5000
**JWT Authorization File: ** Your required to create a Asymetric key when working with JWT this is the approach i took, rather than use Symetric approach
- Generate HSA Private and Public Keys
- Save the Public and Private Keys in files with names:
- privatekey.pem
- publickey.pem
Navigate to the frontend and backend directories and install the required dependencies:
Frontend:
$ cd frontend
$ npm install
Backend:
$ cd backend
$ npm install
Frontend:
$ npm run dev
Backend:
$ npm run dev
blip/
|-- frontend/ # React-based frontend with Material-UI
| |-- src/
| |-- public/
| `-- .env # Frontend environment variables
|
|-- backend/ # Node.js backend with Express
| |-- src/
| `-- .env # Backend environment variables
|
|-- README.md # Project documentation
We welcome contributions! Please fork the repository, create a new branch, and submit a pull request with your changes.
This project is licensed under the MIT License. See the LICENSE
file for more details.
For any questions or feedback, feel free to reach out:
-
Email: bugfix.exe@gmail.com
-
Email: krazygenus@gmail.com
-
GitHub Issues: Open an Issue