AOSSIE | DebateAI

---

About DebateAI

DebateAI is an AI-enhanced, real-time debating platform designed to sharpen communication skills. Whether competing against human opponents or LLM-powered AI challengers, users can participate in structured debates that mimic formal competitions.

Key Features

• User vs. User Debates

• Real-time debates via WebSockets, WebRTC (audio/video/text)

• Structured formats: opening, cross-exam, and closing

• User vs. AI Debates

• LLM-generated counterarguments that adapt to your input

• Custom Debate Rooms

• Create private, topic-specific debate spaces

---

Project Setup Guide

Backend Configuration

Prerequisites

• Go (version 1.20 or later)
• MongoDB (local instance or MongoDB Atlas)

---

1. Create the Backend Config File

The backend expects a config.prod.yml file at runtime.
Only a sample config file is provided in the repository.

Create the required config file by copying the sample:

cd backend/config
cp config.prod.sample.yml config.prod.yml

---

2. Configure MongoDB

Update backend/config/config.prod.yml with a valid MongoDB connection string:

database:
  uri: "<YOUR_MONGODB_URI>"

Without a valid MongoDB URI, the backend will fail to start.

---

3. (Optional) Gemini API Configuration

If the Gemini API key is not configured, the backend will still run, but AI-related features will be disabled.

gemini:
  apiKey: "<YOUR_GEMINI_API_KEY>"

---

4. Run the Backend Server

From the backend directory, start the server:

go run cmd/server/main.go

The server will start on the port defined in the config file (default: 1313).

---

Notes

• Do not commit config.prod.yml to version control.
• Only config.prod.sample.yml should remain committed.

Frontend Configuration

1. In the frontend/ directory, create a file named .env.

2. Add the following environment variables to the .env file:

VITE_BASE_URL="http://localhost:1313"
VITE_GOOGLE_CLIENT_ID="<YOUR_GOOGLE_OAUTH_CLIENT_ID>"

• Replace <YOUR_GOOGLE_OAUTH_CLIENT_ID> with your actual Google OAuth Client ID from Google Cloud Console.

Note: Do not commit this file to a public repository. Add .env to your .gitignore to keep it secure.

---

Running the Frontend (React + Vite)

1. Open a new terminal and navigate to the frontend directory:

   cd frontend
   

2. Install dependencies:

   npm install
   

3. Create a .env file and add:

   VITE_BASE_URL="http://localhost:1313"
   

4. Start the development server:

   npm run dev
   

---

Contribution Guidelines

Thank you for your interest in contributing to DebateAI! We appreciate your efforts in making this project better. Please follow these best practices to ensure smooth collaboration.

How to Contribute

1. Fork the Repository

• Navigate to the DebateAI repository.
• Click the Fork button in the top right corner.
• Clone the forked repository to your local machine:

git clone https://github.com/your-username/DebateAI.git
cd DebateAI

2. Create a Feature Branch

• Always create a new branch for your contributions:

git checkout -b feature-name

3. Make Changes and Commit

• Follow coding best practices and maintain code consistency.
• Write clear commit messages:

git commit -m "Added [feature/fix]: Short description"

4. Push Changes and Open a Pull Request

• Push your changes to your forked repository:

git push origin feature-name

• Navigate to the original repository and open a Pull Request (PR).
• Provide a detailed description of the changes in the PR.

---

Best Practices

• Code Quality: Ensure your code is clean, readable, and consistent with the existing codebase.
• Testing: Test your changes locally before submitting a PR.
• Security: Never commit sensitive information (e.g., API keys or passwords).
• Communication: Be responsive to reviews and update your PRs as requested.

---

Submitting a Video Demonstration

To help maintainers understand your changes, consider submitting a short video showcasing the feature or fix:

• Record a short demo (you can use tools like Loom or OBS).
• Upload and include the video link in your Pull Request description.

---

Reporting Issues

If you find a bug or have a feature request:

• Open an issue here.
• Clearly describe the problem and, if possible, suggest solutions.

We look forward to your contributions!

---

License

MIT © AOSSIE

---