Ruby-CapstoneProject

This is a solo project to finish Microverse's Ruby section that consists of implementing a Telegram bot.

Screenshot:

About the project

The goal of the project is to use all the experience acquired in the Ruby Curriculum to set up the basic elements for the bot.

Prerequisites

To run the bot, you need a personal Telegram account and Ruby installed in your machine.

Installation and Execution

1. Download/clone this repository GitHub Repository on your computer.
2. In your terminal, use the command cd to go to the place where you saved/cloned the repository. For example: Desktop/User/Ruby-CapstoneProject/. You may use the command ls to see the files and repositories existent in your current location.
3. Still in the terminal, run the command bundle install.
4. Now use the command ruby bin/main.rb to automatically access the folder \bin and to start running the bot.
5. If the bot starts running successfully, you'll see the message "Hello there... The bot is running!" in your terminal. [NOTE: I know about the importance of hiding an API token in source code. Because of that, this project provides a Dotenv and a .env (+ .gitignore) file with the code as it should be to hide information, but I preferred to hardcode the token to make it easier for users and TSEs execute the code with no additional commands and complications]

How to use the bot

1. After making sure that the bot is running, you'll need to access the Telegram Web. This link redirects automatically to the bot page. If you want to access from your device (Telegram App), you can search for Ana of Zodiacs in the chats menu.

2. The bot will request for you to start. Let's start!

3. Simply follow to commands to access the bot features or return to the main menu:

   Here's how to use the bot:

   • Use /start to start or restart the bot

   • Use /menu to return to this message

   • Use /stop to end the bot

   • Want to receive your quote of the day? Type /quote

   • Type ' / ' + the zodiac sign you wish to obtain information, or simply select one of the options below:

    /aries    /taurus    /gemini    /cancer
   
    /leo    /virgo    /libra    /scorpio
   
    /sagittarius    /capricorn    /aquarius    /pisces
   

4. After you are done with the bot, simply close the 'bot conversation' and press Ctrl + Z in your terminal to stop running the bot.

Author

👩🏼‍💻 Ana Paula Hübner

• GitHub: @anapdh
• Twitter: @dev_anahub
• LinkedIn: LinkedIn

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

Show your support

Give a ⭐️ if you like this project!

📝 License

This project is MIT licensed.