Skip to main content

Documentation Index

Fetch the complete documentation index at: https://www.doc-reviewer.site/llms.txt

Use this file to discover all available pages before exploring further.

Doc Reviewer работает на Windows. Рекомендуемый способ установки — скачать готовый .exe: Python, Node.js и дополнительная настройка не нужны. Если вы хотите изменить исходный код или запустить приложение в режиме разработки, соберите из исходного кода.

​
Системные требования

ТребованиеПодробности
Операционная системаWindows 10 или Windows 11
Chromium (для оценки веб-страниц)Устанавливается отдельно — см. ниже
Python 3.11 (только при сборке из исходников)Версии 3.12+ не поддерживаются
Node.js 18+ (только при сборке из исходников)Нужен для сборки фронтенда
Python 3.12 и выше не поддерживаются. Парсер PDF зависит от PyMuPDF 1.23, который несовместим с Python 3.12+. Используйте строго Python 3.11.

​
Вариант 1: установка через .exe (рекомендуется)

Это быстрый способ. .exe содержит Python-бэкенд и React-фронтенд в одном файле.
1

Скачайте doc-reviewer.exe

Скачайте актуальный doc-reviewer.exe со страницы релизов и сохраните его в отдельную папку — например, C:\Tools\DocReviewer\.
Держите .exe в отдельной папке. Doc Reviewer создаёт подпапку data\ рядом с исполняемым файлом для хранения базы данных и конфигурации. Если вы поместите .exe на рабочий стол, папка с данными появится там же.
2

Запустите исполняемый файл

Дважды щёлкните doc-reviewer.exe. Приложение стартует локальный бэкенд-сервер и автоматически открывает интерфейс Doc Reviewer в браузере по умолчанию.Если браузер не открылся, перейдите по адресу http://localhost:8000 вручную.
3

Установите Chromium для оценки веб-страниц

.exe не содержит Chromium. Чтобы загружать и оценивать веб-страницы по URL, вам нужно один раз установить Chromium через Playwright.Откройте терминал и выполните:
py -3.11 -m playwright install chromium
Chromium (~150 МБ) загрузится в %LOCALAPPDATA%\ms-playwright. Эту команду нужно выполнить один раз на каждом компьютере.
Если вы планируете оценивать только загружаемые файлы (PDF, DOCX, Markdown, TXT), а не веб-страницы, этот шаг можно пропустить.
Данные хранятся в data\db.sqlite рядом с .exe. База данных создаётся автоматически при первом запуске. Чтобы сбросить все данные, остановите приложение и удалите папку data\.

​
Вариант 2: сборка из исходного кода (для разработчиков)

Используйте этот вариант, если хотите изменить код Doc Reviewer или запустить его в режиме разработки с горячей перезагрузкой.
1

Клонируйте репозиторий

git clone https://github.com/amihailov76/doc-reviewer.git
cd doc-reviewer
2

Установите зависимости Python

py -3.11 -m pip install -r requirements.txt
3

Установите Chromium

py -3.11 -m playwright install chromium
4

Запустите бэкенд

python run_dev.py
Бэкенд запустится на http://localhost:8000 с горячей перезагрузкой.
5

Запустите фронтенд

Откройте второй терминал:
cd frontend
npm install
npm run dev
Фронтенд запустится на http://localhost:5173. Откройте этот адрес в браузере.
В режиме разработки фронтенд работает на порту 5173 (Vite), бэкенд API — на порту 8000 (FastAPI). В готовом .exe оба компонента работают на порту 8000, поэтому два отдельных порта — особенность только режима разработки.

​
Проверка установки

После запуска приложения проверьте работоспособность бэкенда по адресу: 
http://localhost:8000/api/ping
Вы получите ответ: 
{"status": "ok"}
Если вместо этого появляется ошибка или нет ответа, бэкенд не запущен. Попробуйте перезапустить .exe или команду run_dev.py.

​
Где хранятся данные

Doc Reviewer хранит все данные на вашем компьютере:
ПутьСодержимое
data\db.sqlite (рядом с .exe)Все проекты, документы, результаты оценки, настройки моделей
criteria.md (рядом с .exe, необязательно)Пользовательские критерии оценки, которые заменяют встроенные по умолчанию
%LOCALAPPDATA%\ms-playwrightУстановка Chromium (управляется Playwright)
Никакие данные не передаются во внешние системы, кроме вызовов LLM API к провайдеру, который вы настроите в Настройках → Модели.