README.md

UltraChat

UltraChat is a powerful Discord bot designed to enhance productivity in servers by providing chat summarization and management.

---

This project consists of two main components:

• UltraChat Bot - Discord bot for chat summarization
• UltraChat Backend - Golang backend service

Discord Bot

Features

• Discord OAuth2 Integration
• Chat summarization capabilities
• Interactive commands via !help
• Support for multiple API integrations:
  • HuggingFace API
  • Groq API
  • Discord API
  • Cohere API

Bot Installation

1. Clone the repository:

git clone https://github.com/GDGVIT/ultra-chat-bot.git
cd ultra-chat-bot

2. Set up environment variables:

   • Copy .env.example and rename to .env
   • Add all required API keys
   • Configure Discord bot token

3. Create and activate virtual environment:

Windows:

python -m venv venv
.\venv\Scripts\activate

Linux and MacOS:

python -m venv venv
source venv/bin/activate

4. Install dependencies:

pip install -r requirements.txt

5. Run the bot:

python app.py

Backend Service

Backend Features

• JWT based authentication
• User profile management
• Summary management:
  • Create and retrieve chat summaries
  • Update existing summaries
  • Delete summaries
  • Private/Public summary options

Backend Installation

1. Clone the backend repository:

git clone https://github.com/GDGVIT/ultra-chat-backend.git

2. Install Go dependencies:

go mod download

3. Set required environment variables:

export PORT=5001
export MONGODB_URI=your_mongodb_uri
export CLIENT_ID=your_discord_client_id
export CLIENT_SECRET=your_discord_client_secret
export REDIRECT_URI=your_redirect_uri

4. Run the server:

go run main.go

Docker Setup

If you prefer using Docker:

1. Ensure all credentials are in .env
2. Build and run using Docker Compose:

docker-compose build
docker-compose up

API Documentation

View the complete Postman API Documentation for detailed endpoint information.

Key endpoints:

• POST /create-summary - Create new chat summary
• GET /summarizer - Get user summaries
• PUT /update-summary - Update existing summary
• DELETE /delete-summary - Delete summary
• GET /is_authenticated - Check authentication status

Contributors

Noel Alex

Sidhant Srivastav

Aman Singh

Made with ❤ by GDSC-VIT