Files
FoFreeXit/docs/05-dev-setup.md
T
admin 274012f854 Initial commit: FoFreeXit Phase 1 (Viewer) + Phase 2 (Annotate)
PDF viewer (render/search/text-select/thumbnails/outline) and annotation
engine (Highlight/Underline/Strikeout/Square/FreeText/Note) over PDFium +
lopdf, with Unicode font embedding for Vietnamese text and undo/redo.
2026-06-17 22:34:06 +07:00

2.6 KiB

05 — Hướng dẫn build & chạy (dev)

Cập nhật ở cuối Phase 1. Áp dụng cho Windows x64 (môi trường dev hiện tại).

Yêu cầu môi trường

  • Rust (MSVC toolchain), cài qua rustup. Kiểm: rustc --version (hiện 1.96.0).
  • Visual Studio Build Tools + workload Desktop development with C++ (cung cấp cl.exe/link.exe cho linker MSVC).
  • WebView2 Runtime (cho Tauri; Windows 11 thường có sẵn).
  • PDFium: pdfium.dll prebuilt — tải bằng scripts/fetch-pdfium.ps1 (đặt vào gốc workspace + pdfium/).
  • (Tauri) Node không bắt buộc: app dùng frontend tĩnh, chạy thẳng bằng cargo run.

Lấy PDFium

# Tải pdfium.dll (bblanchon/pdfium-binaries) về gốc workspace
powershell -File scripts/fetch-pdfium.ps1

Engine tìm pdfium.dll theo thứ tự: FOFREEXIT_PDFIUM_PATH → cwd → ./pdfium → thư mục exe → thư viện hệ thống.

Cấu trúc

crates/ff-cos        # COS layer (khung)
crates/ff-pdmodel    # PD layer (khung)
crates/ff-engine     # render qua PDFium (Phase 1: render.rs)
crates/ff-cli        # CLI "ff" (info, render)
app/src              # frontend tĩnh (HTML/CSS/JS)
app/src-tauri        # backend Tauri (crate riêng, workspace tách)
corpus/              # PDF mẫu để test
scripts/             # tiện ích (fetch-pdfium)

CLI

# Đếm trang
cargo run -p ff-cli -- info corpus\hello.pdf
# Render trang 0 ra PNG, rộng 800px
cargo run -p ff-cli -- render corpus\hello.pdf out.png --page 0 --width 800
# Kích thước mọi trang
cargo run -p ff-cli -- pages corpus\sample-multipage.pdf
# Trích text 1 trang
cargo run -p ff-cli -- text corpus\sample-multipage.pdf --page 1
# Tìm kiếm (in vị trí + toạ độ)
cargo run -p ff-cli -- search corpus\sample-multipage.pdf content
# Outline / bookmarks
cargo run -p ff-cli -- outline corpus\sample-multipage.pdf

Test

cargo test -p ff-engine          # smoke test render (cần pdfium.dll)

Chạy app desktop (Tauri)

cd app\src-tauri
cargo run                        # mở cửa sổ, hiển thị corpus\hello.pdf

App là một Cargo workspace riêng (có [workspace] trống trong app/src-tauri/Cargo.toml) nên lệnh cargo ở gốc repo không build app, và ngược lại. Đây là chủ ý để tránh xung đột profile build giữa thư viện và Tauri.

Ghi chú

  • Bản dev set FOFREEXIT_PDFIUM_PATH tự động về gốc workspace (xem app/src-tauri/src/main.rs). Bản release sẽ bundle pdfium.dll như resource (việc của Phase 8).