Skip to content

AlinGeorgescu/Math-Bot

Repository files navigation

Build status Contributors Forks Stargazers Issues MIT License


UPB Logo

Math-Bot

Bachelor Thesis Project @ University Politehnica of Bucharest
Faculty of Automatic Control and Computers
Computer Engeneering Department

Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgements

About The Project

Product

MathBot is an application that consists of an interactive agent and aims to help students learn math through questions and answers. The bot is built as a collection of Maths courses built as an interactive agent. Each course has several learning steps and a test, in the end.

Built With

And other libraries.

Getting Started

The app is deployed on a cloud VM, but you can run it locally, too.

Prerequisites

Install Docker and Docker Compose.

Create a Telegram bot using BotFather and get an API token.

Create environment files for the Docker containers, as in the following example:

  • database_adapter_con_info.env
    • DB_ADAPT_PORT=5000
    • DB_ADAPT_ADDR=0.0.0.0
  • database_con_info.env
    • POSTGRES_DB=db_name
    • POSTGRES_USER=db_user
    • POSTGRES_PASSWORD=db_pass
  • frontend_con_info.env
    • API_TOKEN=key_from_botfather
  • math_bot_con_info.env
    • MATH_BOT_PORT=5001
    • MATH_BOT_ADDR=0.0.0.0

Launching

docker-compose up --build  # start the application
docker-compose rm -v       # stop the application and remove any volumes

Usage

Open the chat with MathBot on Telegram and type /start. Then, the bot will send you additional information. Type /help to list all the supported commands.

You will then start your courses and get through them, step by step. You will have one question after finishing half of the course, it is not mandatory and answering it will not give you any points. After the final step of a course, its test will start. The questions must be answered for full score. The answer should be as clear as possible and should not use abbreviations. The bot will tell you if your answer is correct or not.

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

LinkedIn

Author: Alin Georgescu

Project Link: Math-Bot

Acknowledgements

  • Othneil Drew - README template
  • Rod Pierce & Math is fun - Some graphics for the courses
  • Aritmetică, Algebră, Geometrie: clasa a V-a: anul școlar 2009-2010, Ediția a 14-a, Pitești, România, Editura Paralela 45, 2009 - Some texts for the courses