Skip to content

Commit

Permalink
Update(README): Added short FAQ to configure and start the bot
Browse files Browse the repository at this point in the history
  • Loading branch information
valerii-chirkov committed Aug 29, 2023
1 parent d9ab2ec commit 5ce4a22
Showing 1 changed file with 34 additions and 2 deletions.
36 changes: 34 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,35 @@
# anime_bot
# Anime Bot
## _Смотри аниме в своем боте_
##
### Попробовать бота можно здесь: https://t.me/ValeraAnimeBot
##
### Stack list:
- Aiogram - API для работы с телеграм ботами.
- Asyncpg - Асинхронный драйвер для postgres.
- SqlAlchemy - ORM для работы с бд.
- Alembic - Миграции бд.
- Pydantic - Валидация и представления данных.
- [AnilibriaAPI](https://github.com/anilibria/docs) - API для получения аниме.
##
### Установка с docker-compose
Для начала необходимо добавить свои креды в файл **env_dist** и переименовать его в **.env**
Список полей:
- BOT_NAME - Имя вашего бота, можно не указывать, но пригодится для логирования в какую-то общую бд.
- ADMIN_ID - Ваш ID как пользователя, нужен для уведомлялок.
- BOT_TOKEN - Токен бота, берется у BotFather.
- DB_URL - Урл для подключения к postgres, меняете аргументы на свои по желанию.
- PG_USER, PG_PASSWORD и тд можно не указывать, оставлено для использования в каких-то определенных сценариях.

Также потребуется прописать креды подключения в docker-compose:
- POSTGRES_USER - имя пользователя.
- POSTGRES_PASSWORD - пароль пользователя.
- POSTGRES_DB - название вашей бд.
Остальные аргументы на усмотрение.


Когда все готово, поднимаем наши контейнеры:
```sh
sudo docker-compose up --build -d
```
Если все прошло успешно, то мы сможем сразу пользоваться нашим ботом.

Try it: @ValeraAnimeBot

0 comments on commit 5ce4a22

Please sign in to comment.