Skip to content

avneesh0612/tldr-bot

Repository files navigation

Welcome to tldr bot 👋

License: GPL--3.0 Twitter: twitter.com\/avneesh0612

TLDRBot is a Discord bot that generates a summary of any conversation. Use the /tldr command to generate a summary of the conversation.

Using it

The discord bot is self hostable. You can use it by following the steps below:

  • Fork the repo
  • Create a new application on the Discord Developer Portal
  • Create a bot user and copy the token
  • Create a .env file and add the token as BOT_TOKEN
  • Copy the client ID and add it in .env as BOT_ID
  • Create a new database on CockroachDB
  • Paste in the connection string as DATABASE_URL
  • Run npx prisma db push && npx prisma generate
  • Create a new API key on OpenAI
  • Paste the key as OPENAI_API_KEY

You are now ready to run the bot. You can use pnpm run dev to run the bot in development mode or host it!

Install

pnpm install

Usage

pnpm run start

🤝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page.

Show your support

Give a ⭐️ if this project helped you!

📝 License

Copyright © 2023 Avneesh Agarwal.
This project is GPL--3.0 licensed.

About

TLDRBot is a Discord bot that generates a summary of any conversation. Use the /tldr command to generate a summary of the conversation.

Resources

License

Code of conduct

Stars

Watchers

Forks