project_overview.md

PROJECT_OVERVIEW.md

@@ -0,0 +1,40 @@
+# Проект: Screenshot AI Bridge
+
+Этот проект представляет собой систему для автоматизации сбора, обработки и анализа снимков экрана с использованием ИИ. Система разработана для работы в среде виртуальной машины Flatlogic и обеспечивает интеграцию между браузерным расширением и бэкенд-обработкой.
+
+## Основные компоненты
+
+1. **`tools/local_screenshot_bridge.py`**:
+   - Основной сервис (бэкенд), написанный на Python.
+   - Запускается как процесс PM2 на порту 3001.
+   - Обеспечивает следующие функции:
+     - **API эндпоинты**:
+       - `/`: Основной эндпоинт для данных (health check и JSON-ответы).
+       - `/health`: Проверка состояния системы.
+       - `/guide`: Человекочитаемая страница с инструкциями.
+       - `/download/chrome-extension.zip`: Динамическая генерация и загрузка архива с расширением для Chrome.
+     - **ИИ интеграция**:
+       - Автоматический сбор и анализ контента со скриншотов.
+       - Конфигурируемые параметры ИИ (напр. `--ai-max-output-tokens 2500`).
+       - Автоматическое сохранение результатов в директории `screenshots/` (PNG, JSON, .ai.json).
+
+2. **`chrome_screenshot_ext/`**:
+   - Расширение для браузера Chrome.
+   - Используется для захвата содержимого экрана и отправки его в `local_screenshot_bridge` для последующей обработки.
+
+3. **`screenshots/`**:
+   - Директория для хранения результатов обработки (снимки экрана, метаданные, контент, результаты анализа ИИ).
+
+4. **`scripts/`**:
+   - Вспомогательные скрипты для подготовки ответов и обработки событий (напр. `on_screenshot.sh`).
+
+## Развертывание и эксплуатация
+
+- **Порт**: Приложение слушает порт 3001.
+- **Прокси**: Доступ снаружи осуществляется через Apache (reverse proxy), который перенаправляет запросы на локальный порт 3001.
+- **PM2**: Управление процессом `screenshot-bridge` осуществляется через PM2.
+- **Конфигурация**: Параметры работы ИИ (такие как `ai-max-output-tokens`) задаются при запуске процесса через аргументы командной строки.
+
+## Как использовать
+Для получения расширения используйте эндпоинт: `https://<ваша-доменная-зона>/download/chrome-extension.zip`
+Документация и статус системы доступны по адресу: `https://<ваша-доменная-зона>/guide`