README.md

Minerva

[Blog] [Demo on YouTube (of old Discord version)]

Minerva is a GPT-powered Telegram bot built to help community members learn software development.

How can I add Minerva to my Telegram group (chat)?

By default, the bot uses the gpt-4o-2024-08-06 model from OpenAI, which costs $10.00 / 1M output tokens. You can use this online tokenizer from OpenAI to estimate how many tokens it will take to encode your text.

You can switch to a different OpenAI model by defining the OPENAI_MODEL environment variable. For example, OPENAI_MODEL=gpt-4o will make Minerva use the latest GPT-4o model.

To run Minerva, you'll need to:

• install poetry
• create a Telegram bot and obtain the Telegram bot token
• create an OpenAI account and get the OpenAI token
• obtain the id of the Telegram group (chat) that you want to add the bot to

After you have done this:

1. Copy .env.example to .env.
2. Enter your Telegram bot token, OpenAI API key, and Telegram group (chat) id into .env. The bot will only function within this group.
3. In the terminal, navigate to the project dir and run:

poetry install
poetry run minerva

Using Docker

You can also run Minerva using docker. To run Minerva in docker, follow the instructions above, but skip poetry installation and, instead of the commands suggested in step 3, run:

docker compose up

What about Discord?

If you are looking for Minerva with Discord support, check out the Minerva v1.

Contributing

This repository follows the Conventional Commits standard.

License

MIT