🚗 Telegram Car Bot

Этот бот создан для управления автомобилями, ведения учёта расходов, напоминаний о сервисах и многого другого. Он легко запускается с помощью Docker и готов к использованию без специальных знаний.

🔧 Функции бота

• Добавление и управление автомобилями
• Создание заметок о расходах
• Напоминания о событиях
• Учёт покупок и их управление
• Удобное меню для взаимодействия
• Учёт проведённых ТО, кастомные шаблоны ТО

📋 Как запустить бота шаг за шагом

Шаг 1: Клонируйте репозиторий

Сначала скачайте код на ваш компьютер. Для этого откройте терминал (или командную строку) и выполните команду:

git clone https://github.com/Sayrrexe/SF-Car-Bot.git
cd SF-Car-Bot # переходим в каталог с ботом

Шаг 2: Установите Docker

Мы предполагаем, что Вы используете дистрибутивы Linux Ubuntu или Red Hat, в других случаях, если у вас ещё нет Docker, скачайте и установите его:

• Инструкция по установке Docker

Шаг 3: Настройка переменных окружения

Боту нужен токен Telegram и база данных для работы. Создайте файл .env в корне проекта с таким содержимым:

TOKEN=ВАШ_ТОКЕН_ОТ_TELEGRAM
DB_URL=sqlite://db.sqlite3
DB_HOST=db
DB_PORT=5432
DB_USER=postgres
DB_PASS=postgres
DB_NAME=postgres

Как получить токен:

1. Откройте Telegram и найдите BotFather.
2. Введите /newbot и следуйте инструкциям.
3. После создания бота вы получите токен.

Шаг 4: Запуск бота через Docker

После установки Docker и создания файла .env можно запускать бота. Всё, что вам нужно сделать:

1. Откройте терминал в папке с проектом.
2. Выполните команду:

chmod +x start.sh

она создаст контейнер с ботом, теперь запустите его командой:

./start.sh

Готово! Вы великолепны, можете наслаждаться работой бота 🎉

Шаг 5: Запуск бота вручную (если не хотите использовать Docker)

1. Убедитесь, что у вас установлен Python 3.10 или выше. версию Python можно проверить командой

python -v

2. Создайте файл .env и добавьте туда ваш ТОКЕН как это было показано выше
3. Установите зависимости, выполнив команду:

pip install -r requirements.txt

4. Запустите бота:

python run.py

Теперь ваш бот готов к работе! 🎉

🛠 Команды для взаимодействия с ботом

• /start — начать взаимодействие с ботом
• /menu — открыть главное меню
• /help — список всех доступных команд

💡 Советы

• Убедитесь, что вы правильно настроили файл .env.
• Если по каким-то причинам вы не хотите использовать PostgreSql:

1.поменять настройки .env на эти:

TOKEN=ВАШ_ТОКЕ_БЕЗ_ПРОБЕЛОВ_И_СКОБОЧЕК
DB_URL=sqlite://db.sqlite3

2. Раскоментировать с 23 по 34 строчки и закоментировать с 37 по 56:

# sqlite
TORTOISE_ORM = {
    "connections": {
        "default": DB_URL,
    },
    "apps": {
        "models": {
            "models": ["app.database.models", "aerich.models"],
            "default_connection": "default",
        },
    },
}


#TORTOISE_ORM = {
#    "connections": {
#        "default": {
#            "engine": "tortoise.backends.asyncpg",
#            "credentials": {
#                "host": DB_HOST,
#                "port": DB_PORT,
#                "user": DB_USER,
#                "password": DB_PASS,
#                "database": DB_NAME,
#            },
#        }
#    },
#    "apps": {
#        "models": {
#            "models": ["app.database.models", "aerich.models"],
#            "default_connection": "default",
#        }
#    },
#}

измените 21 строчку run.py на:

db_url=DB_URL,

Готово, теперь ваша БД использует sqlite