-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
35 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,35 @@ | ||
# Telegram bot for ksiVPN prjoect | ||
- [ ] add use-case; | ||
- [ ] add gif, showing tg bot abilities; | ||
- [ ] add normal description. | ||
# Telegram bot for ksiVPN project | ||
Multifunctional telegram bot for ksiVPN based on aiogram framework and using modules: asyncpg2, apscheduler, aiomoney, gpt4free. Deployment is possible using Docker with docker-compose. | ||
|
||
## Features | ||
- __aiogram2 support__ | ||
- __PostgreSQL usage__ | ||
- __P2P payments via YooMoney__ | ||
- __ChatGPT integration__ | ||
- __subscription mechanics: renewal, expiration notifications__ | ||
- __localizations support__ | ||
- panels for unauthorized users, authorized users and admin | ||
- rapid deployment via Docker | ||
- database backups via bot | ||
- asynchronous code | ||
- logging | ||
|
||
## Use Case diagram | ||
Here will be the Use Case diagram. | ||
|
||
## Database diagram | ||
Here wil be the Database diagram. | ||
|
||
## Installation | ||
1. Install Docker with Docker Compose according to the [official instructions](https://docs.docker.com/engine/install/). | ||
2. Install git according to the [official instructions](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git). | ||
3. Register new telegram bot using [BotFather](https://t.me/BotFather) and get bot's token. | ||
4. `git clone https://github.com/exmanka/ksiVPN-telegram-bot.git` — download the repository to your computer. | ||
5. `cd ksiVPN-telegram-bot` — move to project directory. | ||
6. Change text file `.env` according to your needs. | ||
__Important:__ all environment variables marked with `# !` sign MUST be entered! | ||
7. `docker compose up` — build images and run containers. | ||
|
||
## Usage | ||
Now you can write to your bot and enjoy all its pre-installed features. You are free to play with functionality and database filling. Learn something new for yourself! 🎉 | ||
### Please mention me in your releases if you use my project for own purposes. |