GymBot

Telegram Gym Bot

Telegram bot for training groups which want to help each other stay motivated

Report Bug · Request Feature

Table of Contents

• Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Contact

Built With

• Python 3.8
• MongoDB

Getting Started

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

Prerequisites

Telegram bot token

1. Download the Telegram app to your phone
2. Create telegram bot

https://core.telegram.org/bots#creating-a-new-bot

when finishing to create the bot its important to save his token.

MongoDB

• Set up MongoDB database (there is free options that would fit development).

if needed you can use this guide for the set up

https://docs.atlas.mongodb.com/getting-started/

when finishing to set up the MongoDB its important to save the connection string.

Installation

1. Clone the repo

git clone https://github.com/AsafSH6/GymBot.git

2. Enter the project directory

cd ./GymBot

2. Install dependencies

pip install -r requirements.txt

3. Setup environment variables

export BOT_TOKEN=<telegram_bot_token>
export MONGODB_URL_CON=<MongoDB_connection_string>

Usage

• To start the server you need to run the follwing command.

python gym_bot_app/gym_bot.py

• To start using the bot

1. Create telegram group with your friends
2. Add GymiousBot to the group
3. Use the bot commands set to start

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/amazing-feature)
3. Commit your Changes (git commit -m 'Add some amazing-feature')
4. Push to the Branch (git push origin feature/amazing-feature)
5. Open a Pull Request

Contact

• email: asafsemail@gmail.com

• Project Link: https://github.com/AsafSH6/GymBot