buongiorno-caffe-bot

Crates.iobuongiorno-caffe-bot
lib.rsbuongiorno-caffe-bot
version0.2.1
sourcesrc
created_at2022-09-02 16:12:31.923176
updated_at2022-09-21 19:00:38.344437
descriptionA telegram bot to receive the best italian boomer flavoured buongiornissimi
homepagehttps://github.com/veeso/buongiorno-caffe-bot
repositoryhttps://github.com/veeso/buongiorno-caffe-bot
max_upload_size
id657456
size119,681
Christian Visintin (veeso)

documentation

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



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


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

  • /buonnatale

    get a christmas image

  • /compleanno <name> <date>

    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 https://t.me/buongiornocaffe_bot to start a chat with Big Luca bot, then add it to any group or chat directly with him.

telegram-qr

Developers

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

  1. Clone this repository git clone git@github.com:veeso/buongiorno-caffe-bot.git
  2. Create your bot with the 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=<YOUR_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 https://ticondivido.it and https://buongiornissimocaffe.it

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 PayPal bitcoin litecoin


Powered by 💪


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


Changelog ⏳

View buongiorno-caffe-bot's changelog HERE


License 📃

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

You can read the entire license HERE

Commit count: 19

cargo fmt