An open API service indexing awesome lists of open source software.

https://github.com/veeso/buongiorno-caffe-bot

The best italian boomer flavoured good morning and coffee moka related images at your command
https://github.com/veeso/buongiorno-caffe-bot

Last synced: about 1 month ago
JSON representation

The best italian boomer flavoured good morning and coffee moka related images at your command

Awesome Lists containing this project

README

        

# buongiorno-caffe-bot



~ The best italian boomer flavoured good morning and coffee moka related images at your command ~

Developed by @veeso


Current version: 0.2.1 (21/09/2022)


License-Unlicense
Repo stars
Downloads counter
Latest version

Ko-fi



Build CI
Coveralls

---

- [buongiorno-caffe-bot](#buongiorno-caffe-bot)
- [About buongiorno-caffe-bot 📰](#about-buongiorno-caffe-bot-)
- [Command API 🐚](#command-api-)
- [Get started 🏁](#get-started-)
- [Users](#users)
- [Developers](#developers)
- [Deploy with heroku](#deploy-with-heroku)
- [Roadmap 🎯](#roadmap-)
- [Support the developer ☕](#support-the-developer-)
- [Powered by 💪](#powered-by-)
- [Contributing and issues 🤝🏻](#contributing-and-issues-)
- [Changelog ⏳](#changelog-)
- [License 📃](#license-)

---

## About buongiorno-caffe-bot 📰

buongiorno-caffe-bot is a Telegram bot to receive the best italian boomer flavoured good morning and coffee moka related images.

![Demo](/docs/images/demo.gif)

---

## Command API 🐚

- `/auguri`

get a happy birthday image

- `/buongiornissimo`

get a good morning image

- `/buonpomeriggio`

get a good afternoon image

- `/buonanotte`

get a good night image

- `/compleanno `

configure a birthday

- `/caffeee`

This command will make the bot to send automatic messages

> ❗ Automatic messages includes daily images

- `/puliziakontatti`

Opt out from automatic messages

- `/help`

display help

---

## Get started 🏁

### Users

Scan this QR code or go to this URL to start a chat with Big Luca bot, then add it to any group or chat directly with him.

![telegram-qr](/docs/images/qr-code-md.webp)

### Developers

If you want to develop on this bot, you can follow these simple steps:

1. Clone this repository `git clone [email protected]:veeso/buongiorno-caffe-bot.git`
2. Create your bot with the [Botfather](https://t.me/botfather)
3. Get your API key
4. Set your API key in your environment using the variable `TELOXIDE_TOKEN`
5. Set your database path in your environment using the variable `DATABASE_URI`
6. Touch the database file `touch $DATABASE_URI`
7. Run the buongiorno-caffe bot

#### Deploy with heroku

You can then deploy your own version of the buongiorno-caffe bot using `heroku`, with these simple steps:

1. Create your heroku app `heroku create --buildpack emk/rust`
2. configure the Telegram API key with `heroku config:set TELEGRAM_API_KEY=`
3. git push heroku main

---

## Roadmap 🎯

1. Add more celebrations (such as valentine, 25th april, 2nd june, ...)
2. Add more image providers such as and

---

## Support the developer ☕

If you like buongiorno-caffe-bot and you're grateful for the work I've done, please consider a little donation 🥳

You can make a donation with one of these platforms:

[![ko-fi](https://img.shields.io/badge/Ko--fi-F16061?style=for-the-badge&logo=ko-fi&logoColor=white)](https://ko-fi.com/veeso)
[![PayPal](https://img.shields.io/badge/PayPal-00457C?style=for-the-badge&logo=paypal&logoColor=white)](https://www.paypal.me/chrisintin)
[![bitcoin](https://img.shields.io/badge/Bitcoin-ff9416?style=for-the-badge&logo=bitcoin&logoColor=white)](https://btc.com/bc1qvlmykjn7htz0vuprmjrlkwtv9m9pan6kylsr8w)
[![litecoin](https://img.shields.io/badge/Litecoin-345d9d?style=for-the-badge&logo=Litecoin&logoColor=white)](https://blockchair.com/litecoin/address/ltc1q89a7f859gt7nuekvnuuc25wapkq2f8ny78mp8l)

---

## Powered by 💪

- [teloxide](https://github.com/teloxide/teloxide)
- [tokio](https://tokio.rs/)

---

## Contributing and issues 🤝🏻

Contributions, bug reports, new features and questions are welcome! 😉
If you have any question or concern, or you want to suggest a new feature, or you want just want to improve buongiorno-caffe-bot, feel free to open an issue or a PR.

Please follow [our contributing guidelines](CONTRIBUTING.md)

---

## Changelog ⏳

View buongiorno-caffe-bot's changelog [HERE](CHANGELOG.md)

---

## License 📃

buongiorno-caffe-bot is licensed under the Unlicense license.

You can read the entire license [HERE](LICENSE)