From e3ce855e1104916583e04f69375b4107a7fa9469 Mon Sep 17 00:00:00 2001 From: Ilnar Date: Thu, 5 Mar 2026 10:32:05 +0300 Subject: [PATCH] fix Readme --- README.md | 32 ++++++++++++++++++-------------- 1 file changed, 18 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 61de7fe..9e440f5 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,9 @@ Монорепозиторий из 3 сервисов: -1) **agents_service** (FastAPI) — агент №1 (генерация текстов) и агент №2 (анализ/ранжирование по метрикам) -2) **backend_django** (Django + DRF + JWT, SQLite) — хранение брифов/вариантов/тестов/результатов + Swagger -3) **frontend** (React/Vite) — пользовательский интерфейс для создания брифа, выбора форматов и генерации текстов +1. **agents_service** (FastAPI) — агент №1 (генерация текстов) и агент №2 (анализ/ранжирование по метрикам) +2. **backend_django** (Django + DRF + JWT, SQLite) — хранение брифов/вариантов/тестов/результатов + Swagger +3. **frontend** (React/Vite) — пользовательский интерфейс для создания брифа, выбора форматов и генерации текстов ## Возможности (MVP0) @@ -14,20 +14,20 @@ - Swagger для backend: `http://localhost:8000/api/docs/` - Swagger для agents: `http://localhost:8001/docs` -> Модуль тестирования (создание тестов, сегменты, ручной ввод результатов, анализ) уже заложен в backend, -> но UI для него можно расширять следующим шагом. - --- ## Быстрый старт через Docker (рекомендуется) ### 1) Требования + - Docker Desktop (Windows/macOS) или Docker Engine + Compose (Linux) ### 2) Скачивание + Склонируйте репозиторий или распакуйте архив в папку, например `adsassistant_full_project`. ### 3) Настройка секретов GigaChat + Откройте файл: `agents_service/.env` и заполните: ```env @@ -36,6 +36,7 @@ GIGACHAT_CLIENT_SECRET=... ``` ### 4) Запуск + Из корня проекта: ```bash @@ -43,6 +44,7 @@ docker compose up --build ``` Откройте: + - Frontend: http://localhost:5174 - Backend Swagger: http://localhost:8000/api/docs/ - Agents Swagger: http://localhost:8001/docs @@ -52,6 +54,7 @@ docker compose up --build ## Запуск без Docker (локальная разработка) ### 1) Agents Service (8001) + ```bash cd agents_service python -m venv .venv @@ -63,6 +66,7 @@ python -m uvicorn src.main:app --reload --port 8001 ``` ### 2) Django Backend (8000) + ```bash cd backend_django python -m venv .venv @@ -73,6 +77,7 @@ python manage.py runserver 0.0.0.0:8000 ``` ### 3) Frontend (5174) + ```bash cd frontend npm install @@ -84,15 +89,15 @@ npm run dev ## Первый сценарий использования -1) Создайте пользователя: +1. Создайте пользователя: - В Swagger backend: `POST /api/auth/register/` -2) Получите JWT: +2. Получите JWT: - `POST /api/auth/token/` → `access` -3) Во фронтенде войдите с логином/паролем -4) Создайте бриф: +3. Во фронтенде войдите с логином/паролем +4. Создайте бриф: - заполните продукт, аудиторию, выберите форматы -5) Нажмите **«Сгенерировать тексты (Агент №1)»** -6) Посмотрите список вариантов (ID + format + payload) +5. Нажмите **«Сгенерировать тексты (Агент №1)»** +6. Посмотрите список вариантов (ID + format + payload) --- @@ -127,12 +132,11 @@ adsassistant_full_project/ - включить HTTPS и нормальные секреты - добавить роль admin и отдельную админ-панель/страницы - Note: frontend/public is optional; docker build does not require it. - ## JWT токены (время жизни) В `backend_django/adsassistant_backend/adsassistant_backend/settings.py` настроено: + - ACCESS token: 1 день - REFRESH token: 7 дней