Skip to content

Latest commit

 

History

History
236 lines (162 loc) · 7.21 KB

README.md

File metadata and controls

236 lines (162 loc) · 7.21 KB
Raw

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo

Bilkent Super Bot (Beta)

A bot provides many services to help Bilkent University students in daily school life.
View changelog »

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. Acknowledgments

About The Project

Many routine things in a university student's life that day do every day. Bilkent Super Bot aims to reduce this boring stuff and make life easier for students.

Here's why:

  • Auto meal menu sender
  • Auto Academic Calendar events sender
  • Auto Club Activity sender
  • +10 full automatic functions

Of course, Bilkent Super Bot does not solve every student's all problems, but at least it reduces the routine.

You can start using right now: https://t.me/bilkent_super_bot

(back to top)

Built With

  • Python
  • SQLite

(back to top)

Getting Started

Bilkent Super Bot is very easy to set up. You can easily start using it in a few minutes by following the steps below.

Prerequisites

Download and install:

  • Python 3.6+
  • SQLite

Installation

Local

  1. Get a free API Key from Telegram Botfather
  2. Clone the repo 
    git clone https://github.com/alpsencer/bilkent-super-bot.git
  3. Install Python packages from requirements.txt 
    pip install -r requirements.txt
  4. Enter your API in .env and named as TELEGRAM_TOKEN 
    TELEGRAM_TOKEN=your_token
  5. Run the script

Docker (Local)

  1. Create the Docker container from Dockerfile
  2. Run the container

Docker (Docker Hub Image)

  1. Our Docker image will be released soon

(back to top)

Usage

You can use our bot from here: t.me/bilkent_super_bot

(back to top)

Roadmap

Detailed Roadmap: BSB Roadmap Changelog

  • Meal Menu Sender
  • Auto Meal Menu Notifications Sender
  • Database support (SQLite)
  • Fully Dockerized
  • Auto Academic Calender Event Sender
  • Publishing Docker images to Docker Hub
  • Auto Club Acitivity Sender
  • Open AI GPT-3 Support

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

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

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  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

(back to top)

License

Distributed under the GNU GPL V3. See LICENSE.txt for more information.

(back to top)

Contact

Yavuz Alp Sencer OZTURK - @alpsencerozturk Project Link: https://github.com/alpsencer/bilkent-super-bot

(back to top)

Acknowledgments

  • +200 daily user
  • +20000 message sended (total)

(back to top)