trevor/smartsoltech_site
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

📚 Project restructuring and CI/CD setup

Browse Source 
✨ Major reorganization:
- Move all documentation to docs/ directory
- Clean up root directory from temporary files
- Add comprehensive project documentation
- Implement Drone CI/CD pipeline

📁 Structure changes:
- docs/SCRIPTS_README.md - Complete scripts guide
- docs/DEPLOYMENT.md - Production deployment guide
- docs/API.md - Comprehensive API documentation
- patch/ - Temporary and test files
- Clean .gitignore with proper exclusions

🚀 CI/CD Pipeline (.drone.yml):
- Code quality checks (flake8, black, bandit)
- Unit and integration testing
- Docker image building and security scanning
- Staging deployment automation
- Production deployment on tags
- Telegram notifications
- Scheduled maintenance tasks

📖 Enhanced README.md:
- Technology stack badges with icons
- Drone CI build status badge
- Comprehensive quick start guide
- Clear project architecture
- Links to all documentation

🔧 Additional improvements:
- MIT License added
- .gitkeep files for important directories
- Improved .gitignore patterns
- Professional project presentation

🎯 Result: Clean, professional project structure ready for production
This commit is contained in:
Andrey K. Choi
2025-11-25 07:00:36 +09:00
parent 8f1e0459fc
commit 19d523213b
18 changed files with 1627 additions and 833 deletions
Download Patch File Download Diff File Expand all files Collapse all files

542
docs/API.md Normal file
View File

@@ -0,0 +1,542 @@
# 🤖 SmartSolTech API Documentation
## 📡 API Endpoints Overview
SmartSolTech предоставляет RESTful API для взаимодействия с системой управления заказами и интеграции с внешними сервисами.
### Base URL
```
Production: https://smartsoltech.kr/api/
Development: http://localhost:8000/api/
```
## 🔐 Аутентификация
### API Token Authentication
```http
Authorization: Token your-api-token-here
```
**Получение токена:**
```bash
# Через CLI
./cli manage drf_create_token <username>
# Через Django shell
./cli shell
>>> from django.contrib.auth.models import User
>>> from rest_framework.authtoken.models import Token
>>> user = User.objects.get(username='admin')
>>> token = Token.objects.create(user=user)
>>> print(token.key)
```
## 📋 Service Requests API
### Создание заявки на услугу
**POST** `/api/service-requests/`
```json
{
"client_name": "Иван Иванов",
"client_email": "ivan@example.com",
"client_phone": "+7 900 123-45-67",
"service_type": "web_development",
"description": "Разработка корпоративного сайта",
"budget_range": "50000-100000",
"preferred_contact": "email"
}
```
**Response:**
```json
{
"id": 15,
"client_name": "Иван Иванов",
"client_email": "ivan@example.com",
"client_phone": "+7 900 123-45-67",
"service_type": "web_development",
"description": "Разработка корпоративного сайта",
"budget_range": "50000-100000",
"preferred_contact": "email",
"status": "pending",
"qr_code_url": "/static/qr_codes/request_15.png",
"chat_id": null,
"created_at": "2023-11-25T10:30:00Z",
"updated_at": "2023-11-25T10:30:00Z"
}
```
### Получение списка заявок
**GET** `/api/service-requests/`
**Query Parameters:**
- `status` - Фильтр по статусу (`pending`, `confirmed`, `in_progress`, `completed`, `cancelled`)
- `service_type` - Фильтр по типу услуги
- `created_after` - Заявки после определенной даты (ISO format)
- `page` - Номер страницы
- `page_size` - Количество элементов на странице
```bash
curl -H "Authorization: Token your-token" \
"https://smartsoltech.kr/api/service-requests/?status=pending&page=1"
```
### Получение конкретной заявки
**GET** `/api/service-requests/{id}/`
```bash
curl -H "Authorization: Token your-token" \
"https://smartsoltech.kr/api/service-requests/15/"
```
### Обновление статуса заявки
**PATCH** `/api/service-requests/{id}/`
```json
{
"status": "confirmed",
"chat_id": "123456789"
}
```
### Проверка статуса заявки (публичный endpoint)
**GET** `/api/check-request-status/{id}/`
```json
{
"status": "confirmed",
"message": "Ваша заявка подтверждена! Мы свяжемся с вами в ближайшее время."
}
```
## 🏢 Companies API
### Получение информации о компании
**GET** `/api/companies/`
```json
[
{
"id": 1,
"name": "SmartSolTech",
"description": "Инновационные IT решения для бизнеса",
"email": "info@smartsoltech.kr",
"phone": "+7 800 555-35-35",
"website": "https://smartsoltech.kr",
"address": "г. Москва, ул. Технологическая, д. 1",
"logo": "/media/company/logo.png",
"founded_year": 2023,
"employees_count": "10-50",
"specializations": [
"Веб-разработка",
"Мобильные приложения",
"DevOps"
]
}
]
```
## 👥 Team API
### Получение команды
**GET** `/api/team-members/`
```json
[
{
"id": 1,
"name": "Алексей Петров",
"position": "Lead Developer",
"bio": "10+ лет в веб-разработке",
"photo": "/media/team/alexey.jpg",
"linkedin": "https://linkedin.com/in/alexey",
"github": "https://github.com/alexey",
"email": "alexey@smartsoltech.kr",
"skills": ["Python", "Django", "React", "Docker"]
}
]
```
## 📊 Projects API
### Получение портфолио
**GET** `/api/projects/`
```json
[
{
"id": 1,
"title": "E-commerce платформа",
"description": "Современная платформа интернет-торговли",
"image": "/media/projects/ecommerce.jpg",
"url": "https://example-shop.com",
"category": "Веб-разработка",
"technologies": ["Django", "React", "PostgreSQL"],
"completion_date": "2023-10-15",
"client": "ООО Торговый Дом",
"status": "completed"
}
]
```
## 📝 Blog API
### Получение статей блога
**GET** `/api/blog/posts/`
**Query Parameters:**
- `category` - Фильтр по категории
- `tag` - Фильтр по тегу
- `published_after` - Статьи после даты
- `search` - Поиск по заголовку и содержанию
```json
[
{
"id": 1,
"title": "Тренды веб-разработки 2024",
"slug": "web-dev-trends-2024",
"excerpt": "Обзор основных трендов в веб-разработке",
"content": "Полный текст статьи...",
"author": {
"name": "Алексей Петров",
"photo": "/media/team/alexey.jpg"
},
"category": {
"name": "Разработка",
"slug": "development"
},
"tags": ["веб-разработка", "тренды", "2024"],
"featured_image": "/media/blog/trends-2024.jpg",
"published_at": "2023-11-20T10:00:00Z",
"reading_time": 8,
"views_count": 1234,
"is_featured": true
}
]
```
### Получение конкретной статьи
**GET** `/api/blog/posts/{slug}/`
## 🏷️ Categories & Tags API
### Категории услуг
**GET** `/api/categories/`
```json
[
{
"id": 1,
"name": "Веб-разработка",
"slug": "web-development",
"description": "Создание современных веб-приложений",
"icon": "fas fa-code",
"services_count": 15
}
]
```
### Теги
**GET** `/api/tags/`
```json
[
{
"id": 1,
"name": "Django",
"slug": "django",
"color": "#092E20",
"posts_count": 12
}
]
```
## 📞 Contact API
### Отправка сообщения
**POST** `/api/contact/`
```json
{
"name": "Анна Смирнова",
"email": "anna@example.com",
"subject": "Вопрос по услугам",
"message": "Здравствуйте! Интересует разработка мобильного приложения.",
"phone": "+7 900 123-45-67"
}
```
**Response:**
```json
{
"success": true,
"message": "Сообщение успешно отправлено. Мы ответим в ближайшее время.",
"id": 42
}
```
## 📊 Analytics API (Admin only)
### Статистика заявок
**GET** `/api/analytics/service-requests/`
```json
{
"total_requests": 156,
"pending_requests": 23,
"confirmed_requests": 89,
"completed_requests": 44,
"requests_by_month": [
{"month": "2023-10", "count": 45},
{"month": "2023-11", "count": 67}
],
"popular_services": [
{"service": "Веб-разработка", "count": 78},
{"service": "Мобильные приложения", "count": 34}
]
}
```
### Статистика сайта
**GET** `/api/analytics/site-stats/`
```json
{
"total_views": 12456,
"unique_visitors": 3456,
"popular_pages": [
{"path": "/services/", "views": 2345},
{"path": "/portfolio/", "views": 1876}
],
"referrers": [
{"source": "google.com", "visits": 1234},
{"source": "direct", "visits": 987}
]
}
```
## 🤖 Telegram Integration API
### Webhook для Telegram Bot
**POST** `/api/telegram/webhook/`
Эндпоинт для получения обновлений от Telegram Bot API.
### Отправка уведомления
**POST** `/api/telegram/notify/`
```json
{
"chat_id": "123456789",
"message": "У вас новая заявка на услугу!",
"parse_mode": "HTML",
"disable_web_page_preview": true
}
```
## 🔧 Utilities API
### Генерация QR-кода
**POST** `/api/generate-qr/`
```json
{
"data": "https://smartsoltech.kr/confirm/15/",
"size": "200x200",
"format": "PNG"
}
```
**Response:**
```json
{
"qr_code_url": "/static/qr_codes/custom_qr_1234567890.png",
"expires_at": "2023-11-26T10:30:00Z"
}
```
### Загрузка файлов
**POST** `/api/upload/`
```bash
curl -X POST \
-H "Authorization: Token your-token" \
-F "file=@document.pdf" \
-F "category=documents" \
"https://smartsoltech.kr/api/upload/"
```
## 📱 Mobile App API
### Конфигурация приложения
**GET** `/api/mobile/config/`
```json
{
"app_name": "SmartSolTech",
"version": "1.0.0",
"api_version": "v1",
"features": {
"push_notifications": true,
"offline_mode": true,
"biometric_auth": true
},
"endpoints": {
"base_url": "https://smartsoltech.kr/api/",
"websocket_url": "wss://smartsoltech.kr/ws/"
}
}
```
## 🚨 Error Handling
### Стандартные HTTP коды
- `200 OK` - Успешный запрос
- `201 Created` - Ресурс создан
- `400 Bad Request` - Некорректные данные
- `401 Unauthorized` - Необходима аутентификация
- `403 Forbidden` - Недостаточно прав
- `404 Not Found` - Ресурс не найден
- `429 Too Many Requests` - Превышен лимит запросов
- `500 Internal Server Error` - Ошибка сервера
### Формат ошибок
```json
{
"error": {
"code": "VALIDATION_ERROR",
"message": "Некорректные данные",
"details": {
"email": ["Введите корректный email адрес"],
"phone": ["Номер телефона обязателен"]
},
"timestamp": "2023-11-25T10:30:00Z",
"request_id": "req_1234567890"
}
}
```
## 🔒 Rate Limiting
### Лимиты для разных типов пользователей
- **Anonymous**: 100 запросов в час
- **Authenticated**: 1000 запросов в час
- **Premium**: 10000 запросов в час
### Headers ответа
```http
X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1635724800
```
## 📚 SDK и библиотеки
### Python SDK
```python
from smartsoltech_api import SmartSolTechClient
client = SmartSolTechClient(
api_key='your-api-key',
base_url='https://smartsoltech.kr/api/'
)
# Создание заявки
request = client.service_requests.create({
'client_name': 'Test Client',
'service_type': 'web_development',
'description': 'Test request'
})
# Получение статистики
stats = client.analytics.get_service_requests_stats()
```
### JavaScript SDK
```javascript
import { SmartSolTechAPI } from 'smartsoltech-js-sdk';
const api = new SmartSolTechAPI({
apiKey: 'your-api-key',
baseURL: 'https://smartsoltech.kr/api/'
});
// Создание заявки
const request = await api.serviceRequests.create({
clientName: 'Test Client',
serviceType: 'web_development',
description: 'Test request'
});
// Получение проектов
const projects = await api.projects.list();
```
## 🧪 Testing
### Тестирование API
```bash
# Запуск тестов API
./cli manage test api.tests
# Тестирование конкретного эндпоинта
./cli manage test api.tests.test_service_requests
# Запуск coverage
./cli exec coverage run --source='.' manage.py test
./cli exec coverage report
```
### Примеры запросов
```bash
# Получение токена
curl -X POST http://localhost:8000/api/auth/token/ \
-H "Content-Type: application/json" \
-d '{"username": "admin", "password": "password"}'
# Создание заявки
curl -X POST http://localhost:8000/api/service-requests/ \
-H "Authorization: Token your-token" \
-H "Content-Type: application/json" \
-d '{
"client_name": "Test Client",
"client_email": "test@example.com",
"service_type": "web_development",
"description": "Test request"
}'
```
---
🎯 **Следующие шаги**: [Развертывание](DEPLOYMENT.md) | [Управление скриптами](SCRIPTS_README.md)

352
docs/DEPLOYMENT.md Normal file
View File

@@ -0,0 +1,352 @@
# 🚀 Руководство по развертыванию SmartSolTech
## 📋 Подготовка сервера
### Системные требования
- **OS**: Ubuntu 20.04+ / CentOS 8+ / Debian 11+
- **RAM**: Минимум 2GB, рекомендуется 4GB+
- **Storage**: Минимум 20GB свободного места
- **Network**: Открытые порты 80, 443, 8000, 5432, 8080
### Установка Docker
```bash
# Ubuntu/Debian
curl -fsSL https://get.docker.com -o get-docker.sh
sh get-docker.sh
# Добавление пользователя в группу docker
sudo usermod -aG docker $USER
# Установка Docker Compose
sudo curl -L "https://github.com/docker/compose/releases/download/v2.21.0/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
sudo chmod +x /usr/local/bin/docker-compose
```
## 🔧 Настройка проекта
### 1. Клонирование репозитория
```bash
git clone https://github.com/smartsoltech/smartsoltech.kr.git
cd smartsoltech.kr
```
### 2. Конфигурация переменных окружения
```bash
# Копирование примера конфигурации
cp smartsoltech/.env.example smartsoltech/.env
# Редактирование конфигурации
nano smartsoltech/.env
```
**Основные переменные:**
```env
DEBUG=False
SECRET_KEY=your-super-secret-key
DATABASE_URL=postgresql://user:password@postgres_db:5432/smartsoltech
TELEGRAM_BOT_TOKEN=your-telegram-bot-token
ALLOWED_HOSTS=yourdomain.com,www.yourdomain.com
```
### 3. Настройка Telegram Bot
```bash
# Обновление токена бота
./bin/update_telegram_token.py
# Или через CLI
./cli manage set_telegram_token <YOUR_BOT_TOKEN>
```
## 🚀 Развертывание
### Автоматическое развертывание
```bash
# Полное обновление и запуск
./update
# Проверка статуса
./cli status
```
### Пошаговое развертывание
```bash
# 1. Остановка старых контейнеров
./stop
# 2. Сборка образов
docker-compose build --no-cache
# 3. Запуск сервисов
docker-compose up -d
# 4. Выполнение миграций
./cli migrate
# 5. Создание суперпользователя
./cli createsuperuser
# 6. Сбор статических файлов
./cli collectstatic
```
## 🔒 Настройка SSL/HTTPS
### Использование Let's Encrypt
```bash
# Установка Certbot
sudo apt install certbot python3-certbot-nginx
# Получение сертификата
sudo certbot --nginx -d yourdomain.com -d www.yourdomain.com
# Настройка автообновления
sudo crontab -e
# Добавить: 0 12 * * * /usr/bin/certbot renew --quiet
```
### Настройка Nginx
```nginx
# /etc/nginx/sites-available/smartsoltech
server {
listen 80;
server_name yourdomain.com www.yourdomain.com;
return 301 https://$server_name$request_uri;
}
server {
listen 443 ssl http2;
server_name yourdomain.com www.yourdomain.com;
ssl_certificate /etc/letsencrypt/live/yourdomain.com/fullchain.pem;
ssl_certificate_key /etc/letsencrypt/live/yourdomain.com/privkey.pem;
location / {
proxy_pass http://localhost:8000;
proxy_set_header Host $host;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Forwarded-Proto $scheme;
}
location /static/ {
alias /path/to/smartsoltech.kr/smartsoltech/staticfiles/;
expires 1y;
add_header Cache-Control "public, immutable";
}
location /media/ {
alias /path/to/smartsoltech.kr/smartsoltech/media/;
expires 1y;
add_header Cache-Control "public, immutable";
}
}
```
## 📊 Мониторинг и логи
### Системные логи
```bash
# Логи всех сервисов
./logs
# Логи конкретного сервиса
./logs web
./logs db
./logs pgadmin
# Последние 100 строк
./logs --tail 100
```
### Мониторинг ресурсов
```bash
# Использование ресурсов контейнерами
docker stats
# Размер образов и контейнеров
docker system df
# Проверка дискового пространства
df -h
```
### Health Checks
```bash
# Проверка состояния сервисов
./cli status
# Подключение к базе данных
./cli dbshell
# Проверка Django
./cli check
```
## 🔄 Backup и восстановление
### Настройка автоматических бэкапов
```bash
# Настройка backup репозитория
./bin/setup-backup.sh git@backup-server.com:backups/smartsoltech.git
# Добавление в crontab
crontab -e
# Добавить: 0 2 * * * cd /path/to/smartsoltech.kr && ./update origin backup
```
### Backup базы данных
```bash
# Создание дампа БД
docker-compose exec postgres_db pg_dump -U postgres smartsoltech > backup_$(date +%Y%m%d).sql
# Восстановление из дампа
docker-compose exec -i postgres_db psql -U postgres smartsoltech < backup_20231125.sql
```
### Backup медиафайлов
```bash
# Создание архива медиафайлов
tar -czf media_backup_$(date +%Y%m%d).tar.gz smartsoltech/media/
# Восстановление медиафайлов
tar -xzf media_backup_20231125.tar.gz
```
## 🚨 Troubleshooting
### Частые проблемы
**1. Контейнер не запускается**
```bash
# Проверка логов
./logs web
# Пересборка образов
./stop --clean
./update
```
**2. Ошибки базы данных**
```bash
# Проверка подключения к БД
./cli dbshell
# Проверка миграций
./cli showmigrations
# Сброс миграций (ОСТОРОЖНО!)
./cli migrate --fake-initial
```
**3. Проблемы с статическими файлами**
```bash
# Пересбор статики
./cli collectstatic --clear
# Проверка прав доступа
./cli exec ls -la /app/smartsoltech/staticfiles/
```
### Логи для диагностики
```bash
# Django логи
./logs web
# База данных логи
./logs db
# Nginx логи (если используется)
sudo tail -f /var/log/nginx/error.log
# Системные логи
sudo journalctl -u docker.service
```
## 📈 Оптимизация производительности
### Настройки Django
```python
# smartsoltech/settings.py
DATABASES = {
'default': {
'ENGINE': 'django.db.backends.postgresql',
'OPTIONS': {
'MAX_CONNS': 20,
'conn_max_age': 600,
}
}
}
# Кэширование
CACHES = {
'default': {
'BACKEND': 'django.core.cache.backends.redis.RedisCache',
'LOCATION': 'redis://redis:6379/1',
}
}
```
### Docker оптимизации
```yaml
# docker-compose.yml
services:
web:
deploy:
resources:
limits:
memory: 512M
reservations:
memory: 256M
```
## 🔐 Безопасность
### Основные рекомендации
1. **Обновление системы:**
```bash
sudo apt update && sudo apt upgrade
```
2. **Настройка Firewall:**
```bash
sudo ufw enable
sudo ufw allow ssh
sudo ufw allow 80
sudo ufw allow 443
```
3. **Ограничение доступа к админке:**
```python
# settings.py
ADMIN_URL = 'secret-admin-url/'
```
4. **Регулярные обновления:**
```bash
# Еженедельное обновление
./update
```
---
🎯 **Следующие шаги**: [API документация](API.md) | [Управление скриптами](SCRIPTS_README.md)