Skip to content

Latest commit

 

History

History
60 lines (47 loc) · 3.26 KB

README.md

File metadata and controls

60 lines (47 loc) · 3.26 KB

🎉 What is this?

I don't like the official website, I don't like visiting there every day to see just the menu. Here, Hacettepe Cafeteria Bot comes as a simple solution to this issue. What's even better is that you don't need to install mobile or desktop apps to use such a simple tool. You can directly use it via Telegram.

Platform Description Link
🤖 Telegram Bot Directly interact with the Hacettepe Cafeteria Bot 🌐
📢 Telegram Channel Get the updates with image only 🌐
📢 Telegram Channel Get the updates with text only 🌐
📧 Mailing List Subscribe to receive updates via email 🌐

🦾 How To Contribute?

Hacettepe Cafeteria Bot is an uncomplicated tool with a straightforward aim. Only thing that makes it really useful is the problem it solves. Therefore, we don't see many contributions. Yet, you can still request new features or report the issues you faced. For those who knows a bit Python also can help with the development.

🐛 Feature Requests & Reporting Issues

Any "I encountered this bug or that bug" or "oh, I think this feature would be useful" type of communications can be done by opening an issue on GitHub. If you don't use GitHub, and came here to see what's going on, you can send email to current maintainer furkansimsekli.

💻 Development

Grab an issue from the list, and open a PR. Issues with good first issue tags are specifically tagged that way so that new volunteers can make contributions easier. Please consider opening a new issue if you are going to do something unheard of.

🏠 Development Environment

After cloning the repository, you should create a virtual environment. Python3.11 is recommended but any version higher than or equal to 3.9 should work just fine. Then, install the requirements.

# Clone the repository
git clone [email protected]:hacettepeoyt/hu-cafeteria-bot.git
cd hu-cafeteria-bot

# Create a virtual environment with venv and activate it 
python3 -m venv .venv
source .venv/bin/activate

# Install the requirements
pip install -r requirements.txt

Fill the missing configurations in config.toml. Then, run the following command:

python -m src -c <path/to/config.toml> -d <path/to/database.json>

📃 License

GPL-3.0