Skip to content

A Telegram bot built with ruby that recommends books of a chosen genre and sends quotes according to the user's mood.

License

Notifications You must be signed in to change notification settings

aliciapaz/ruby_bot

Repository files navigation

Ruby Capstone Project

Fritz The Librarian Bot

A Telegram Bot that recommends books of a chosen genre and sends random quotes according to the user's mood.

Why a librarian bot?

Nowadays, many people would rather look at memes on instagram than take the time to sit down and enjoy a good read. Perhaps in a few years, human librarians will no longer exist, as everything will be fully automated. As a friendly reminder for children and adults, the librarian bot is the ideal synthesis between modern technologies and old habits that should not be lost.

screenshot screenshot

Demo Video

Watch a video demo HERE

Built With

  • Ruby
  • telegram-bot-ruby gem
  • Telegram's BotFather
  • RSpec

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

Install

Clone the repository

  • Click on the "code" button above in this page and copy the link of the repository
  • Open a terminal (CTRL + ALT + T), type git clone and paste the link you copied in the previous step, then hit Enter
  • Go to the cloned repository using cd command

Setup

  • Run bundle install to install the required gems in your computer
  • From within the directory of the project, type fritz to run the exectuable file and hit Enter

Usage

  • Go to the Telegram app and search for fritz_librarian_bot
  • Click on the Start button or type /start to initialize the bot.
  • Type /book to get a recommendation of a book. You can choose from the genres listed: Novel, Philosophy, Poetry, Theatre, Science or Children
  • Type /quote to get a random quote according to your mood
  • Type /help to see the list of available commands
  • Use CTRL + C in your terminal to stop the bot

Run tests

From the root folder, run rspec to run the tests

Authors

👤 Alicia Paz Rojas

🤝 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!

Acknowledgments

📝 License

This project is MIT licensed.

About

A Telegram bot built with ruby that recommends books of a chosen genre and sends quotes according to the user's mood.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages