docs: add QUICKSTART guide for quick deployment
This commit is contained in:
131
QUICKSTART.md
Normal file
131
QUICKSTART.md
Normal file
@@ -0,0 +1,131 @@
|
|||||||
|
# 🎯 Быстрый старт SmartSolTech
|
||||||
|
|
||||||
|
## ✅ Проект готов к использованию!
|
||||||
|
|
||||||
|
### 📊 Текущий статус
|
||||||
|
- ✅ Код проверен и организован
|
||||||
|
- ✅ Документация создана
|
||||||
|
- ✅ Docker конфигурация готова
|
||||||
|
- ✅ Скрипты автоматизации добавлены
|
||||||
|
- ✅ Изменения закоммичены в Git
|
||||||
|
- ⏳ Готов к push в репозиторий
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 🚀 Для деплоя выполните:
|
||||||
|
|
||||||
|
### 1️⃣ Отправьте изменения в репозиторий
|
||||||
|
```bash
|
||||||
|
git push origin master
|
||||||
|
```
|
||||||
|
|
||||||
|
### 2️⃣ Создайте .env файл
|
||||||
|
```bash
|
||||||
|
cp .env.example .env
|
||||||
|
```
|
||||||
|
|
||||||
|
### 3️⃣ Сгенерируйте SECRET_KEY
|
||||||
|
```bash
|
||||||
|
python -c "from django.core.management.utils import get_random_secret_key; print(get_random_secret_key())"
|
||||||
|
```
|
||||||
|
|
||||||
|
### 4️⃣ Отредактируйте .env
|
||||||
|
```bash
|
||||||
|
nano .env
|
||||||
|
```
|
||||||
|
|
||||||
|
**Обязательно измените:**
|
||||||
|
- `SECRET_KEY` - вставьте сгенерированный ключ
|
||||||
|
- `DEBUG=False` - для production
|
||||||
|
- `ALLOWED_HOSTS=ваш-домен.com`
|
||||||
|
- `POSTGRES_PASSWORD` - сильный пароль
|
||||||
|
- `PGADMIN_DEFAULT_PASSWORD` - сильный пароль
|
||||||
|
|
||||||
|
### 5️⃣ Проверьте конфигурацию
|
||||||
|
```bash
|
||||||
|
./scripts/check-config.sh
|
||||||
|
```
|
||||||
|
|
||||||
|
### 6️⃣ Запустите деплой
|
||||||
|
```bash
|
||||||
|
# Development
|
||||||
|
docker-compose up -d
|
||||||
|
|
||||||
|
# Production
|
||||||
|
docker-compose -f docker-compose.prod.yml up -d
|
||||||
|
|
||||||
|
# Или используйте автоматический скрипт
|
||||||
|
./scripts/deploy.sh
|
||||||
|
```
|
||||||
|
|
||||||
|
### 7️⃣ Создайте суперпользователя
|
||||||
|
```bash
|
||||||
|
docker-compose exec web python smartsoltech/manage.py createsuperuser
|
||||||
|
```
|
||||||
|
|
||||||
|
### 8️⃣ Настройте Telegram бота
|
||||||
|
```bash
|
||||||
|
docker-compose exec web python scripts/update_telegram_token.py
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 📱 Доступ к приложению
|
||||||
|
|
||||||
|
После запуска:
|
||||||
|
- **Приложение**: http://localhost:8000
|
||||||
|
- **Админка**: http://localhost:8000/admin
|
||||||
|
- **PgAdmin**: http://localhost:8080
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 📚 Документация
|
||||||
|
|
||||||
|
- **README.md** - Обзор проекта
|
||||||
|
- **docs/DEPLOYMENT.md** - Полное руководство по деплою
|
||||||
|
- **docs/ENV_VARIABLES.md** - Все переменные окружения
|
||||||
|
- **CONTRIBUTING.md** - Для разработчиков
|
||||||
|
- **CHANGELOG.md** - История изменений
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 🔧 Полезные команды
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Просмотр логов
|
||||||
|
docker-compose logs -f
|
||||||
|
|
||||||
|
# Перезапуск сервисов
|
||||||
|
docker-compose restart
|
||||||
|
|
||||||
|
# Остановка
|
||||||
|
docker-compose down
|
||||||
|
|
||||||
|
# Применить миграции
|
||||||
|
docker-compose exec web python smartsoltech/manage.py migrate
|
||||||
|
|
||||||
|
# Собрать статику
|
||||||
|
docker-compose exec web python smartsoltech/manage.py collectstatic
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## ⚠️ Важно!
|
||||||
|
|
||||||
|
1. **НЕ коммитьте .env файл!** Он в .gitignore
|
||||||
|
2. Используйте `DEBUG=False` в production
|
||||||
|
3. Настройте HTTPS для production (см. scripts/setup-ssl.sh)
|
||||||
|
4. Регулярно делайте backup базы данных
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 🆘 Помощь
|
||||||
|
|
||||||
|
Если возникли проблемы:
|
||||||
|
1. Проверьте логи: `docker-compose logs -f`
|
||||||
|
2. Смотрите docs/DEPLOYMENT.md
|
||||||
|
3. Запустите `./scripts/check-config.sh`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
**Успешного деплоя! 🎉**
|
||||||
Reference in New Issue
Block a user