From f16ffff48a8c6c7293c8d3dafe50e6f5c20c3c77 Mon Sep 17 00:00:00 2001 From: root Date: Mon, 15 Sep 2025 00:58:40 +0200 Subject: [PATCH] add dependencies and how to start --- README.md | 25 +++++++++++++++++++++++++ requirements.txt | 23 +++++++++++++++++++++++ 2 files changed, 48 insertions(+) create mode 100644 requirements.txt diff --git a/README.md b/README.md index ddad5bf..ee11bac 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,31 @@ # Connex A Telegram bot that eases sharing VPN configurations with users +### How to get started + +1. **Create a virtual environment:** + ```bash + python3 -m venv venv + ``` +2. **Activate the virtual environment:** + * **On macOS / Linux:** + ```bash + source venv/bin/activate + ``` + * **On Windows:** + ```bash + venv\Scripts\activate + ``` +3. **Install dependencies:** + ```bash + pip install -r requirements.txt + ``` +4. **Run the bot:** + ```bash + python3 main.py + ``` +5. **For convenience, you can create a systemd service to run the bot in the background.** + ## Key Features - Admin panel for managing users and configurations. - Ability to add and edit tutorials for users to help them understand how to use client applications. diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..6b7bbf4 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,23 @@ +aiofiles==24.1.0 +aiogram==3.22.0 +aiohappyeyeballs==2.6.1 +aiohttp==3.12.15 +aiosignal==1.4.0 +aiosqlite3==0.3.0 +annotated-types==0.7.0 +asyncio==4.0.0 +attrs==25.3.0 +certifi==2025.8.3 +charset-normalizer==3.4.3 +frozenlist==1.7.0 +idna==3.10 +magic-filter==1.0.12 +multidict==6.6.4 +propcache==0.3.2 +pydantic==2.11.9 +pydantic_core==2.33.2 +requests==2.32.5 +typing-inspection==0.4.1 +typing_extensions==4.15.0 +urllib3==2.5.0 +yarl==1.20.1