Files
ChatBot/docs/quickstart.md
Leonid Pershin e5e69470f8
All checks were successful
SonarQube / Build and analyze (push) Successful in 3m22s
add docs
2025-10-21 05:08:40 +03:00

149 lines
3.7 KiB
Markdown
Raw Permalink Blame History

This file contains invisible Unicode characters
This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# 🚀 Быстрый старт
Запустите ChatBot за 5 минут!
## ⚡ Минимальные требования
- **.NET 9.0 SDK** ([скачать](https://dotnet.microsoft.com/download/dotnet/9.0))
- **PostgreSQL 14+** ([скачать](https://www.postgresql.org/download/))
- **Ollama** с установленной моделью ([установить](https://ollama.ai/))
- **Telegram Bot Token** ([создать через @BotFather](https://t.me/botfather))
## 📋 Шаги установки
### 1⃣ Клонирование репозитория
```bash
git clone https://github.com/mrleo1nid/ChatBot.git
cd ChatBot
```
### 2⃣ Установка Ollama и модели
```bash
# Установите Ollama с официального сайта
# https://ollama.ai/
# Загрузите модель (например, gemma2)
ollama pull gemma2:2b
```
### 3⃣ Настройка PostgreSQL
```bash
# Создайте базу данных
psql -U postgres
CREATE DATABASE chatbot;
\q
```
### 4⃣ Создание .env файла
Создайте файл `.env` в папке `ChatBot/`:
```env
# Database Configuration
DB_HOST=localhost
DB_PORT=5432
DB_NAME=chatbot
DB_USER=postgres
DB_PASSWORD=your_password
# Telegram Bot Configuration
TELEGRAM_BOT_TOKEN=your_bot_token_here
# Ollama Configuration
OLLAMA_URL=http://localhost:11434
OLLAMA_DEFAULT_MODEL=gemma2:2b
```
### 5⃣ Запуск приложения
```bash
# Восстановление зависимостей
dotnet restore
# Применение миграций (автоматически при первом запуске)
# или вручную:
dotnet ef database update --project ChatBot
# Запуск
dotnet run --project ChatBot
```
## 🎉 Готово!
Теперь откройте Telegram и найдите вашего бота. Отправьте `/start` для начала общения.
## 📱 Первые команды
```
/start - Начать работу с ботом
/help - Показать все команды
/clear - Очистить историю диалога
/settings - Текущие настройки
/status - Статус бота
```
## 🐳 Альтернатива: Docker
```bash
# Сборка образа
docker build -t chatbot .
# Запуск с docker-compose
docker-compose up -d
```
## 🔧 Проверка работы
### Проверка Ollama
```bash
curl http://localhost:11434/api/tags
```
### Проверка PostgreSQL
```bash
psql -U postgres -d chatbot -c "SELECT * FROM chat_sessions;"
```
### Просмотр логов
Логи находятся в папке `ChatBot/logs/`:
```bash
tail -f ChatBot/logs/telegram-bot-*.log
```
## ❓ Проблемы?
### Ollama недоступен
```bash
# Проверьте статус
systemctl status ollama # Linux
# или запустите вручную
ollama serve
```
### Ошибка подключения к БД
```bash
# Проверьте PostgreSQL
pg_isready -h localhost -p 5432
```
### Неверный токен бота
- Получите новый токен через [@BotFather](https://t.me/botfather)
- Обновите `TELEGRAM_BOT_TOKEN` в `.env`
## 📚 Следующие шаги
- [Полная установка и настройка](./installation.md)
- [Конфигурация](./configuration.md)
- [Архитектура проекта](./architecture/overview.md)
- [Разработка](./development/project-structure.md)
## 💡 Полезные ссылки
- [Ollama Models](https://ollama.ai/library)
- [Telegram Bot API](https://core.telegram.org/bots/api)
- [PostgreSQL Documentation](https://www.postgresql.org/docs/)
- [.NET Documentation](https://docs.microsoft.com/dotnet/)