danvics/openreader
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
No description
631 commits 2 branches 59 tags 8.5 MiB
TypeScript 95.1%
JavaScript 2.9%
CSS 1.8%
Dockerfile 0.2%
Find a file
Richard R fe59685454 feat(worker): add granular PDF progress reporting and abort error handling 
Introduce per-page progress events for PDF parsing by adding onPageStarted
hooks throughout the compute worker and core PDF pipeline. Add
compute/worker/src/pdf-progress.ts to encapsulate progress event builders.
Update server logic to emit page start and page parsed events, improving
client feedback during long-running PDF jobs.

Add src/lib/server/compute/abort-like-error.ts and integrate isAbortLikeError
to robustly detect and suppress expected aborts in API event streaming.
Update API route to ignore abort-like errors on worker proxy crash.

Add unit tests for abort-like error detection and PDF progress event
generation. Refactor PDF parse logic to allow empty merged regions without
throwing, ensuring downstream flows remain resilient to edge cases.

These changes improve observability, error handling, and reliability for
document parsing and event streaming.
2026-05-29 20:13:59 -06:00
.github refactor(onboarding): modularize onboarding flow logic and improve testability 2026-05-29 18:03:17 -06:00
compute feat(worker): add granular PDF progress reporting and abort error handling 2026-05-29 20:13:59 -06:00
docs-site feat(server): implement unified structured logging with pino and enforce usage 2026-05-27 04:20:17 -06:00
drizzle feat(pdf): implement granular PDF parse progress tracking and migrate to parseState 2026-05-21 10:27:16 -06:00
public update(auth): enhance rate limiting with device/IP backstops and improve UI 2026-01-25 14:38:31 -07:00
scripts refactor(onboarding): modularize onboarding flow logic and improve testability 2026-05-29 18:03:17 -06:00
src feat(worker): add granular PDF progress reporting and abort error handling 2026-05-29 20:13:59 -06:00
tests feat(worker): add granular PDF progress reporting and abort error handling 2026-05-29 20:13:59 -06:00
.dockerignore refactor(onboarding): modularize onboarding flow logic and improve testability 2026-05-29 18:03:17 -06:00
.env.example feat(server): implement unified structured logging with pino and enforce usage 2026-05-27 04:20:17 -06:00
.gitattributes Fix check mark in SettingsModal 2025-02-11 21:31:11 -07:00
.gitignore refactor(onboarding): modularize onboarding flow logic and improve testability 2026-05-29 18:03:17 -06:00
.npmrc chore: add .npmrc for npm configuration 2026-05-21 11:18:41 -06:00
Dockerfile build(docker): include compute/core and worker package manifests for deps 2026-05-26 19:33:41 -06:00
drizzle.config.pg.ts Refactor authentication schema and database handling 2026-02-15 12:49:23 -07:00
drizzle.config.sqlite.ts Refactor authentication schema and database handling 2026-02-15 12:49:23 -07:00
empty-module.ts chore(lint): fix eslint violations in worker config and e2e tests 2026-05-21 21:44:58 -06:00
eslint.config.mjs refactor: roll out phase 7 server error contract 2026-05-27 07:24:07 -06:00
LICENSE Initial commit 2025-01-18 00:36:14 -07:00
next.config.ts hard-cut batch D: enforce worker bundle isolation and CI guard 2026-05-26 16:00:26 -06:00
package.json refactor(package): remove unused compute worker watch script 2026-05-29 19:58:56 -06:00
playwright.config.ts refactor(onboarding): modularize onboarding flow logic and improve testability 2026-05-29 18:03:17 -06:00
pnpm-lock.yaml refactor(doclist): redesign document list with new views, DnD, and windowed UI 2026-05-27 18:59:13 -06:00
pnpm-workspace.yaml feat(compute): add external compute worker backend and integration 2026-05-19 15:21:25 -06:00
postcss.config.mjs First push 2025-01-18 04:58:57 -07:00
README.md hard-cut batch F: remove COMPUTE_MODE docs and env references 2026-05-26 16:28:40 -06:00
tailwind.config.ts fix(tailwind): fix footer layout and tailwind config 2025-11-22 16:32:03 -07:00
tsconfig.json build(tsconfig): add path alias for compute-core control-plane module 2026-05-26 15:45:19 -06:00

README.md

GitHub Release License Docs Playwright Tests Docs Check

GitHub Stars GitHub Forks Discussions

📄🔊 OpenReader

OpenReader is an open source, self-host-friendly text-to-speech document reader built with Next.js for EPUB, PDF, TXT, MD, and DOCX with synchronized read-along playback.

Previously named OpenReader-WebUI.

Get started in the docs.

✨ Highlights

  • 🧱 Layout-aware PDF parsing with PP-DocLayoutV3 (ONNX) — structured block detection, cross-page stitching, and geometry-based highlighting for precise read-along sync.
  • ⏱️ Word-by-word highlighting via ONNX Whisper alignment through the compute worker control plane (NATS JetStream-backed).
  • ⚡ Segment-based read-along for EPUB, PDF, TXT, MD, and DOCX — sentence-aware TTS with cached audio segments, background preloading, and resumable playback.
  • 🎯 Multi-provider TTS — self-hosted OpenAI-compatible servers (Kokoro-FastAPI, KittenTTS-FastAPI, Orpheus-FastAPI) or cloud APIs (OpenAI, Replicate, DeepInfra).
  • 🎧 Audiobook export in m4b/mp3 with resumable chapter processing.
  • 🗂️ Flexible backend — embedded SeaweedFS or S3-compatible storage, SQLite or Postgres, server library import, and device sync.
  • 🐳 Self-host friendly — Docker (amd64/arm64), optional auth, and automatic startup migrations.

🚀 Start Here

Goal Link
Run with Docker Docker Quick Start
Deploy on Vercel Vercel Deployment
Deploy external compute worker Compute Worker (NATS JetStream)
Develop locally Local Development
Configure auth Auth
Configure SQL database Database and Migrations
Configure object storage Object / Blob Storage
Configure TTS providers TTS Providers
Run Kokoro locally Kokoro-FastAPI
Run KittenTTS locally KittenTTS-FastAPI
Get support or contribute Support and Contributing

🧭 Community

📜 License

MIT. See LICENSE.