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 OAuth2 Integration
- Chat summarization capabilities
- Interactive commands via
!help
- Support for multiple API integrations:
- HuggingFace API
- Groq API
- Discord API
- Cohere API
- Clone the repository:
git clone https://github.com/GDGVIT/ultra-chat-bot.git
cd ultra-chat-bot
-
Set up environment variables:
- Copy
.env.example
and rename to.env
- Add all required API keys
- Configure Discord bot token
- Copy
-
Create and activate virtual environment:
Windows:
python -m venv venv
.\venv\Scripts\activate
Linux and MacOS:
python -m venv venv
source venv/bin/activate
- Install dependencies:
pip install -r requirements.txt
- Run the bot:
python app.py
- JWT based authentication
- User profile management
- Summary management:
- Create and retrieve chat summaries
- Update existing summaries
- Delete summaries
- Private/Public summary options
- Clone the backend repository:
git clone https://github.com/GDGVIT/ultra-chat-backend.git
- Install Go dependencies:
go mod download
- 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
- Run the server:
go run main.go
If you prefer using Docker:
- Ensure all credentials are in
.env
- Build and run using Docker Compose:
docker-compose build
docker-compose up
View the complete Postman API Documentation for detailed endpoint information.
Key endpoints:
POST /create-summary
- Create new chat summaryGET /summarizer
- Get user summariesPUT /update-summary
- Update existing summaryDELETE /delete-summary
- Delete summaryGET /is_authenticated
- Check authentication status
Noel Alex | Sidhant Srivastav | Aman Singh |
Made with ❤ by GDSC-VIT