Perpustakaan Telegram Bot

Telegram bot for library management system.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Contributing
5. License

About The Project

Perpustakaan Telegram Bot (Library) is telegram bot for library management system. It can manage member data in a library. This bot consumes Perpustakaan API.

Built With

• Python
• python-telegram-bot

Getting Started

Prerequisites

• Python v3.9.8 or higher
• pip

Installation

1. Clone the repo.

   git clone https://github.com/fahri-r/perpustakaan-bot.git

2. Install Python packages.

   pip install -r requirements.txt

3. Rename .env.example into .env.

4. Set BOT_TOKEN value in .env (you can get the token from BotFather).

   ...
   BOT_TOKEN=
   ...

Usage

Start on the local server

1. Open main.py and uncomment this line.

   ...
   # updater.start_polling() 
   ...
   

2. Also comment this line.

   ...
   updater.start_webhook(listen=HOST,
                         port=int(PORT),
                         url_path=TOKEN,
                         webhook_url=URL_APP + TOKEN)
   ...
   

3. Run main.py.

   python main.py
   

Deployment

When you're ready to deploy this bot into production, you have to change URL_APP value in .env. The value must be the url where the bot is deployed.

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.

License

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