📝 Обновление документации и настроек репозитория
✨ Изменения: - Добавлен файл REPOSITORY.md с информацией о репозитории - Обновлены ссылки в DEPLOY.md на правильный URL репозитория - Исправлена проверка TELEGRAM_BOT_TOKEN в deploy.sh - Добавлена информация о клонировании и работе с репозиторием 🔗 Репозиторий: https://gittea.biveki.ru/BivekiGroup/bivekidaybot
This commit is contained in:
@ -34,7 +34,7 @@ MAX_CONNECTIONS=10
|
|||||||
|
|
||||||
```bash
|
```bash
|
||||||
# 1. Клонируйте репозиторий (если еще не сделали)
|
# 1. Клонируйте репозиторий (если еще не сделали)
|
||||||
git clone <your-repo-url>
|
git clone https://gittea.biveki.ru/BivekiGroup/bivekidaybot.git
|
||||||
cd bivekidaybot
|
cd bivekidaybot
|
||||||
|
|
||||||
# 2. Убедитесь, что stack.env настроен правильно
|
# 2. Убедитесь, что stack.env настроен правильно
|
||||||
|
85
REPOSITORY.md
Normal file
85
REPOSITORY.md
Normal file
@ -0,0 +1,85 @@
|
|||||||
|
# 📦 Информация о репозитории
|
||||||
|
|
||||||
|
## 🔗 Ссылки
|
||||||
|
|
||||||
|
- **Основной репозиторий**: https://gittea.biveki.ru/BivekiGroup/bivekidaybot.git
|
||||||
|
- **Веб-интерфейс**: https://gittea.biveki.ru/BivekiGroup/bivekidaybot
|
||||||
|
|
||||||
|
## 📥 Клонирование репозитория
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# HTTPS
|
||||||
|
git clone https://gittea.biveki.ru/BivekiGroup/bivekidaybot.git
|
||||||
|
|
||||||
|
# SSH (если настроен)
|
||||||
|
git clone git@gittea.biveki.ru:BivekiGroup/bivekidaybot.git
|
||||||
|
```
|
||||||
|
|
||||||
|
## 🚀 Быстрый старт после клонирования
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# 1. Перейти в директорию проекта
|
||||||
|
cd bivekidaybot
|
||||||
|
|
||||||
|
# 2. Настроить переменные окружения
|
||||||
|
cp stack.env.example stack.env
|
||||||
|
nano stack.env # Отредактировать с вашими данными
|
||||||
|
|
||||||
|
# 3. Запустить приложение
|
||||||
|
./deploy.sh
|
||||||
|
```
|
||||||
|
|
||||||
|
## 📋 Обязательные настройки
|
||||||
|
|
||||||
|
После клонирования обязательно настройте в файле `stack.env`:
|
||||||
|
|
||||||
|
- `DATABASE_URL` - URL вашей PostgreSQL базы данных
|
||||||
|
- `TELEGRAM_BOT_TOKEN` - токен вашего Telegram бота
|
||||||
|
|
||||||
|
## 🔄 Обновление локальной копии
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Получить последние изменения
|
||||||
|
git pull origin main
|
||||||
|
|
||||||
|
# Перезапустить с обновлениями
|
||||||
|
docker-compose down
|
||||||
|
docker-compose up -d --build
|
||||||
|
```
|
||||||
|
|
||||||
|
## 📝 Участие в разработке
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Создать новую ветку для функции
|
||||||
|
git checkout -b feature/new-feature
|
||||||
|
|
||||||
|
# Внести изменения и закоммитить
|
||||||
|
git add .
|
||||||
|
git commit -m "Добавлена новая функция"
|
||||||
|
|
||||||
|
# Отправить в репозиторий
|
||||||
|
git push origin feature/new-feature
|
||||||
|
```
|
||||||
|
|
||||||
|
## 🏗️ Структура проекта
|
||||||
|
|
||||||
|
```
|
||||||
|
bivekidaybot/
|
||||||
|
├── src/ # Исходный код приложения
|
||||||
|
│ ├── entities/ # Сущности базы данных
|
||||||
|
│ ├── services/ # Бизнес-логика
|
||||||
|
│ └── config/ # Конфигурация
|
||||||
|
├── Dockerfile # Docker образ
|
||||||
|
├── docker-compose.yml # Docker Compose конфигурация
|
||||||
|
├── stack.env.example # Пример переменных окружения
|
||||||
|
├── deploy.sh # Скрипт автоматического деплоя
|
||||||
|
└── DEPLOY.md # Подробная инструкция по деплою
|
||||||
|
```
|
||||||
|
|
||||||
|
## 🛠️ Технологии
|
||||||
|
|
||||||
|
- **Backend**: NestJS + TypeScript
|
||||||
|
- **Database**: PostgreSQL + TypeORM
|
||||||
|
- **Bot**: Telegraf
|
||||||
|
- **Deployment**: Docker + Docker Compose
|
||||||
|
- **Repository**: Gitea
|
@ -36,7 +36,7 @@ if ! grep -q "DATABASE_URL=postgresql://" stack.env; then
|
|||||||
exit 1
|
exit 1
|
||||||
fi
|
fi
|
||||||
|
|
||||||
if ! grep -q "TELEGRAM_BOT_TOKEN=" stack.env && ! grep -q "your_bot_token_here" stack.env; then
|
if grep -q "your_bot_token_here" stack.env; then
|
||||||
echo "❌ TELEGRAM_BOT_TOKEN не настроен в stack.env"
|
echo "❌ TELEGRAM_BOT_TOKEN не настроен в stack.env"
|
||||||
exit 1
|
exit 1
|
||||||
fi
|
fi
|
||||||
|
Reference in New Issue
Block a user