README.md

UltraChat

A Discord bot to supercharge your productivity in servers

This repository contains the the code for the the discord bot Ultra-Chat.

Installation and running UltraChat

---

You need to have Python installed along with a developer account on discord. Visit their developer's portal and create a bot application and get it's token. Clone the repository using

• git clone https://github.com/GDGVIT/UltraChat.git
• cd ultrachat

1. check .env.example and get all the required api keys

   • HuggingFace api
   • Groq api
   • Discord api
   • Cohere api

2. Host Ultra-chat-backend and provide the respective endpoints

3. Remove the .example from the end of the filename, and this will contain all client secrets for your projects

4. It is recommended to create a python virtual environment

• Windows

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

• Linux and MacOS

source myenv/bin/activate

5. Install the project dependencies using (It is recommended to use python >=3.10)

pip3 install requirements.txt

6. Run the main script

python app.py

Run using Docker

1. Install Docker

2. Make sure all the credentials are available in the .env file as described above

3. Run the command

docker-compose build
docker-compose up

Get the Bot invite link (OAuth2 URL) from your discord developer portal, invite the bot into a server and run the !help command to get a list of commands and start using UltraChat

Contributors

---

Noel Alex

Sidhant Srivastav

Made with ❤ by GDSC-VIT