Skip to content
generated from GDGVIT/template

The combined repository for the ultrachat 2025 project

License

Notifications You must be signed in to change notification settings

GDGVIT/ultrachat

Repository files navigation

GDSC VIT

UltraChat

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


Join Us Discord Chat

This project consists of two main components:

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
  1. Set up environment variables:

    • Copy .env.example and rename to .env
    • Add all required API keys
    • Configure Discord bot token
  2. Create and activate virtual environment:

Windows:

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

Linux and MacOS:

python -m venv venv
source venv/bin/activate
  1. Install dependencies:
pip install -r requirements.txt
  1. 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
  1. Install Go dependencies:
go mod download
  1. 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
  1. 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

Noel Alex

GitHub LinkedIn

Sidhant Srivastav

Sidhant Srivastav

GitHub LinkedIn

Aman Singh

Aman Singh

GitHub LinkedIn

Made with ❤ by GDSC-VIT

About

The combined repository for the ultrachat 2025 project

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published