b558fe1c30
PR checks / web (pull_request) Successful in 10s
PR checks / java (pull_request) Successful in 5m51s
PR checks / macos-sim (pull_request) Successful in 7m8s
Main: tests, deploy, autotests / web (push) Successful in 8s
Main: tests, deploy, autotests / java (push) Successful in 1m28s
Main: tests, deploy, autotests / images-web (push) Successful in 1m22s
Main: tests, deploy, autotests / images-app (push) Failing after 50s
Main: tests, deploy, autotests / deploy (push) Has been skipped
Main: tests, deploy, autotests / autotests (push) Has been skipped
Main: tests, deploy, autotests / rollback (push) Has been skipped
- README сокращён: human-контент перенесён на сайт документации; остались структура, бутстрап, команды, задачи mise, ссылки на документацию. - AGENTS.md: команды docs-* в Development Commands.
71 lines
3.9 KiB
Markdown
71 lines
3.9 KiB
Markdown
# java-word-pdf
|
||
|
||
Конвертация **.docx/.doc → PDF** на чистом Java: `docx4j` 17.3.2 + форк
|
||
`Apache FOP`, без LibreOffice/Aspose. Бинарный `.doc` (Word 97–2003) читается
|
||
собственным мостом [MS-DOC]/[MS-CFB] и переносится в .docx в памяти — дальше
|
||
идёт тем же конвейером. Шрифты упакованы в jar — конвертация не зависит от
|
||
шрифтов, установленных в системе (работает «из коробки» на голом сервере).
|
||
|
||
## Структура
|
||
|
||
```
|
||
java-word-pdf/
|
||
├── wordpdf-core/ библиотека: конвертер, мост .doc, шрифты, диаграммы
|
||
├── wordpdf-app/ REST API: POST /api/v1/convert (Spring Boot 4.1.1, Swagger UI)
|
||
└── wordpdf-web/ веб-интерфейс (React + TypeScript + Vite + Tailwind, вне Maven)
|
||
```
|
||
|
||
## Быстрый старт
|
||
|
||
Первая настройка — project-local mise (ставит temurin-17, maven 3.9.16, node 24,
|
||
python 3.15 в кеш mise, в систему ничего не идёт) + `npm ci` SPA:
|
||
|
||
```bash
|
||
sh bootstrap.sh # Linux / macOS
|
||
powershell -ExecutionPolicy Bypass -File .\bootstrap.ps1 # Windows
|
||
```
|
||
|
||
Дальше всё через обёртку `./mise.sh` (Windows: `.\mise.ps1`):
|
||
|
||
```bash
|
||
./mise.sh run verify # полный гейт перед push: тесты + PMD + JaCoCo
|
||
./mise.sh run app-package && ./mise.sh run app-run # бэкенд на :8080, ключ выключен
|
||
curl -F "file=@doc.docx" http://localhost:8080/api/v1/convert -o doc.pdf
|
||
```
|
||
|
||
Стенды на контейнерах (podman), наружный вход — только nginx-gateway:
|
||
|
||
```bash
|
||
cp .env.example .env # WORDPDF_API_KEY: openssl rand -hex 32
|
||
podman-compose up -d --build # prod-like :9010 (fail-closed: без ключа не встанет)
|
||
podman-compose -f compose.dev.yml up -d --build --force-recreate # dev :9011, без ключа
|
||
```
|
||
|
||
## Задачи проекта (`./mise.sh run <задача>`)
|
||
|
||
|Задача|Содержание|
|
||
|---|---|
|
||
|`verify`|`mvn clean verify` — тесты + PMD + JaCoCo|
|
||
|`verify-nofontconfig`|тот же verify в контейнере без fontconfig (гейт CI; требует podman/docker)|
|
||
|`mem-bench`|замер памяти конвейера (TSV пиков + JFR)|
|
||
|`app-package` / `app-run`|исполняемый jar бэкенда / бэкенд на :8080|
|
||
|`web-install` / `web-build` / `web-lint` / `web-dev`|SPA: `npm ci` / гейт `tsc -b && vite build` / oxlint / :5173|
|
||
|`prod-tests`|прод-автотесты; обязателен `WORDPDF_BASE_URL`, факультативно `WORDPDF_API_KEY`|
|
||
|`docs-install` / `docs-serve` / `docs-build`|сайт документации: venv+pip / preview :8000 / strict-сборка в `site/`|
|
||
|`docs-javadoc` / `docs-deploy`|javadoc core / публикация сайта на rpi (:9012)|
|
||
|
||
Альтернатива обёртке — активировать mise в шелле и работать напрямую
|
||
(`mvn`, `npm`, `python`): `eval "$(./.mise/bin/mise activate bash)"`.
|
||
|
||
## Документация
|
||
|
||
- **Сайт документации** (пользователю / REST API / библиотека / архитектура /
|
||
разработчику / эксплуатация): `http://192.168.88.23:9012/`
|
||
— исходники в `docs/`, публикация `./mise.sh run docs-deploy`,
|
||
javadoc — там же по `/apidocs/`.
|
||
- Веб-конвертер (прод): `https://pjandro.ru/pdf-converter/`.
|
||
- Внутренние справочники для правки кода — `docs/agent/` (pipeline, doc-bridge,
|
||
chart, render-limitations, testing, ci-cd, repo-map), нормативные спецификации
|
||
форматов — `docs/standards/`.
|
||
- Правила репозитория — `AGENTS.md`.
|