Modsquad

Automated Moderation Tool for Content Creation and Streaming

Table of Contents

• Project Structure
• Tech Stack
• Running Locally
  • Prerequisites
  • Installation

Project Structure

.
├── docker-compose.yml                 # Docker orchestration
├── frontend/
│   ├── src/
│   │   ├── App.jsx                    # Main app component
│   │   ├── components/
│   │   │   ├── video/                 # Video processing components
│   │   │   └── ui/                    # shadcn components
│   │   ├── index.jsx                  # React entry point
│   │   └── lib/
│   ├── index.html                     # HTML entry point
│   └── main.cjs                       # Electron main process
├── backend/
│   ├── utils/                         # Backend utility functions
│   ├── main.py                        # FastAPI entry point
│   ├── requirements.txt               # Python dependencies
│   └── Dockerfile                     # Backend container definition

Tech Stack

• React - UI framework
• Vite - Build tool and dev server
• Electron - Desktop app wrapper
• shadcn/ui - Component library
• Tailwind CSS - CSS framework
• FastAPI - Backend API
• OpenAI Whisper - Speech-to-text transcription
• MoviePy - Video/audio processing
• Docker - Backend environment and dependency management

Running Locally

Prerequisites

• Node.js v18 or higher
• Docker Desktop
• Python 3.12
• npm

Installation

1. Clone the repository

git clone https://github.com/kumathy/Modsquad.git && cd Modsquad

2. Start the frontend

From the project root, install dependencies:

cd frontend && npm install

Start dev server and Electron in two separate terminals:

# Terminal 1 — Vite dev server
npm run dev

# Terminal 2 — Electron
npm run start

3. Start the backend

In another separate terminal, from the project root:

docker compose up --build

This builds the Python environment and starts the FastAPI server at http://localhost:8000. The --build flag is only needed the first time or after changes to requirements.txt/Dockerfile. After that, just run:

docker compose up

To stop the backend:

docker compose down