Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bluette1/minderly_bot
A Telegram bot built using the rails framework.
https://github.com/bluette1/minderly_bot
Last synced: 10 days ago
JSON representation
A Telegram bot built using the rails framework.
- Host: GitHub
- URL: https://github.com/bluette1/minderly_bot
- Owner: Bluette1
- Created: 2020-08-07T04:44:44.000Z (over 4 years ago)
- Default Branch: develop
- Last Pushed: 2023-05-24T08:37:50.000Z (over 1 year ago)
- Last Synced: 2024-10-22T07:47:42.130Z (2 months ago)
- Language: Ruby
- Homepage: https://t.me/xextris_bot
- Size: 192 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# minderly_bot
This is project is associated with the capstone project at the end of the main Ruby curriculum at [Microverse](https:www.microverse.org/) - @microverseinc.
## Built With
- Ruby v. 2.6.5
- Rails v. 5.0.7.2
- [Telegram API]((https://core.telegram.org/bots/api) )
## Description
- This is a date checker. It keeps track of all your important events, such as birthdays, anniversaries, etc and sends out message notifications.
- It also sends out RSS feeds to subscribed users and channels.
- The [Telegram Bot API](https://core.telegram.org/bots/api) was used to build this project.
- Built using the [telegram-bot](https://github.com/telegram-bot-rb/telegram-bot) gem.
## Live Demo
[Live app](https://t.me/xextris_bot)
### Run instructions
- You can clone the GitHub repo and type the following commands in the terminal to run the bot locally
- Set up the bot by running
```
./bin/setup
```
#### Setting Environment Variables
- You can set environment variables such as the bot's token in the `secrets.yml` file.
- To see how to do this, please reference the `secrets_copy.yml` file
- Then run the following commands in the terminal inside the project's root directory
```
bin/rails telegram:bot:poller
```
Alternatively, you can create an executable script to run it.
- To add the bot to Telegram, one has to create a Telegram bot account for it using BotFather, and connect to it using the API obtained token.
### How to use the bot
Make sure the bot is running
- In order to use MinderlyBot one has to have a Telegram account.
- Ordinary users are able to interact with the bot via their Telegram accounts.
- The bot is also able to post messages to channels and groups if it is added as an administrator.
- You can also subscribe channels as users, and channels as well as group members are able to interact
with the bot.
### Available commands
- Please enter any of the following commands: ["/start", "/help", "/stop", "/news", "/change_my_birthday", "/change_or_add_birthday", "/change_or_add_anniversary", "/subscribe", "/update"]
### Possible errors
- An incorrect entry for the date might throw a `Date.parse` error:
- Example of an invalid date format
- "769887/22/98"
- Bot Response:
- "invalid date: Incorrect format for birthday date entry."
- Make sure you enter the date in the proposed format.
- Correct entries for date
- Should be in the format "DD/MM/YYYY", for example, "12/06/1993"
### Run Tests
- `bundle exec rake` to run the tests
## Deployment
- You can deploy on [Heroku](https://devcenter.heroku.com/categories/ruby-support)
- Make sure you set up the environment variables required for the telegram config(bot_token, username, group_id, channel_id) for example:
`heroku config:set BOT_TOKEN='Bot token'`
- Start the bot process using
`heroku ps:scale bot=1`
## Potential Future Improvements / Ambitions
- Add integration to [Google Calendar API](https://console.developers.google.com) in order to access national public holidays for the user.
## Authors
👤 **Marylene Sawyer**
- Github: [@Bluette1](https://github.com/Bluette1)
- Twitter: [@MaryleneSawyer](https://twitter.com/MaryleneSawyer)
- Linkedin: [Marylene Sawyer](https://www.linkedin.com/in/marylene-sawyer-b4ba1295/)
# Acknowledgements
- [Creating a Bot using the Telegram Bot API](https://tutorials.botsfloor.com/creating-a-bot-using-the-telegram-bot-api-5d3caed3266d#.13ywsygju)
- There are great samples at [this site](https://core.telegram.org/bots/samples)
- To read more about RSS feeds visit [this Medium site](https://medium.com/@krandles/rss-and-ruby-its-really-simple-a32a8654733a)
## 🤝 Contributing
Contributions, issues and feature requests are welcome!
Feel free to check the [issues page](https://github.com/Bluette1/minderly-bot/issues).
## Show your support
Give a ⭐️ if you like this project!
## 📝 License
This project is [MIT](https://opensource.org/licenses/MIT) licensed.