Giter Site home page Giter Site logo

cyonii / yes-bot Goto Github PK

View Code? Open in Web Editor NEW
7.0 2.0 1.0 365 KB

This project is a telegram bot, a questionnaire that engages users in a series of quiz of very random questions.

License: MIT License

Ruby 100.00%
telegram-bot telegram-api quiz engages-users questionnaire

yes-bot's Introduction

Codacy Badge

About YesBot

This project is a telegram bot that interacts with users. The bot YesBot acts as a friendly questionnaire that engages users in series of quiz of very random questions.

My idea of this bot was to create a simple friendly and educative companion that helps users overcome boredom by sharing random knowledge.

Built With

Getting Started

To get started you must have a Telegram account and a Telegram API token. To get an API token and also create a bot, log into your Telegram app, search for BotFather, initiate a chat with BotFather by clickng "start" or typing /start, then follow subsequent instructions. Learn more here

  • cd into your desired directory where you would like the project to live and run git clone [email protected]:cyonii/yes-bot.git
  • run cd yes-bot to get into the project's directory you just cloned
  • add your Telegram API to your environment variables named as TELEGRAM_TOKEN or hard code it into the token variable in bin/main.rb file as a string
  • run bundle install to install the project's dependencies.
  • run bin/main.rb to initiate bot to start listening.
  • head over to your Telegram app, search for the bot you created by it's username or display name, enter /start to initiate interaction, follow subsequent instructions

Tests

This project has been tested using rspec. To run test, cd into the project's directory and run rspec on your terminal.

Available Commands

  • /start - to start interaction with the bot
  • /quiz - to get a random quiz

Author

๐Ÿค 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

  • telegram-bot-ruby
  • Open Trivia
  • Microverse

๐Ÿ“ License

This project is MIT licensed.

yes-bot's People

Contributors

codacy-badger avatar cyonii avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Forkers

wintan1418

yes-bot's Issues

Team 159: Stand-up code review

Marvelous project idea. Awesome codebase, the implementation is loveable.

Suggestions

Wrap lose code instructions in descriptive methods and call the methods instead. This will make the code easy to follow.

Congratulations ๐Ÿ‘๐Ÿผ

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.