Welcome to the Blank Telegram Bot template, an awesome and efficient way to create async Telegram bots with an Admin panel. This template offers built-in support for multilanguage logic, making it a perfect choice for your next bot development project.
This template uses the following technologies:
To start working on this project, follow these steps:
- Clone the repository:
git clone https://github.com/damhuman/blank-telegram-bot
cd blank-telegram-bot- Create a .env file in the root directory:
cp template.env .env-
Replace the TOKEN value in the .env file.
-
To start the bot, run the following command:
docker-compose up --build -dNote: On the first run, the bot container will fail because the database for the project hasn't been created yet. You can use the db container (PostgreSQL) to create it, but you can also use any other database for the bot (SQLite/MySQL/MariaDB).
- To create the database, run the following commands:
docker-compose exec db psql -U postgrescreate database bot_db;
create user bot_db_user with password '111';
grant all privileges on database bot_db to bot_db_user;After this step, the DB_URL will be:
DB_URL=postgresql://bot_db_user:111@db:5432/bot_db
After configuring the database, you can start the bot again using docker-compose:
docker-compose up --build -dThis template comes with preconfigured basic logic for the UI Admin panel, which you can find at http://localhost/admin_panel. It uses Basic Auth logic for login, and you can change the credentials in the .env file.
You can use the alembic framework to handle database migrations. To create a migration, use the following command:
alembic revision --autogenerate -m "Message"Migrations are applied automatically when you run the docker-compose up command. If your table is not parsed via alembic, you have to import it inside the env.py alembic file:
database/alembic/env.pyWe welcome pull requests! For major changes, please open an issue first to discuss what you would like to change.
This template is licensed under the MIT License.