danvics/openreader
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
No description
817 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 b2bbd8fbef feat(data-storage): migrate all user state from IndexedDB to server-backed storage 
Remove all Dexie/IndexedDB code and dependencies, including document and preview caches, local config, onboarding, and migration logic. Replace with server-backed React Query hooks for documents, folders, preferences, onboarding, and progress. Add browser Cache Storage for blob caching of documents, previews, and audio. Update API routes, database schema, and tests to support folder management, onboarding state, and server-side persistence of all user data. Refactor UI and hooks to use server state exclusively, ensuring all user state is synced and portable across devices.

BREAKING CHANGE: All user data, preferences, onboarding, and document state are now stored and synced on the server; browser IndexedDB is no longer used. Existing local-only data will not be available after this update.
2026-06-14 18:13:39 -06:00
.github refactor: implement modular monorepo packages 2026-06-13 13:51:18 -06:00
docker/examples docs(deploy): add local-slim and local-full Docker Compose examples and update docs 2026-06-13 14:09:37 -06:00
docs-site feat(data-storage): migrate all user state from IndexedDB to server-backed storage 2026-06-14 18:13:39 -06:00
packages feat(data-storage): migrate all user state from IndexedDB to server-backed storage 2026-06-14 18:13:39 -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: implement modular monorepo packages 2026-06-13 13:51:18 -06:00
src feat(data-storage): migrate all user state from IndexedDB to server-backed storage 2026-06-14 18:13:39 -06:00
tests feat(data-storage): migrate all user state from IndexedDB to server-backed storage 2026-06-14 18:13:39 -06:00
.dockerignore Refactor PDF parsing and rendering logic; migrate to compute-worker protocol 2026-06-12 13:43:33 -06:00
.env.example docs(security): update secret key generation instructions to use base64 encoding 2026-06-07 14:07:45 -06:00
.gitattributes Fix check mark in SettingsModal 2025-02-11 21:31:11 -07:00
.gitignore refactor(compute-worker): migrate compute logic to modular architecture 2026-06-12 14:07:15 -06:00
.npmrc chore: add .npmrc for npm configuration 2026-05-21 11:18:41 -06:00
Dockerfile refactor: implement modular monorepo packages 2026-06-13 13:51:18 -06: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 feat(data-storage): migrate all user state from IndexedDB to server-backed storage 2026-06-14 18:13:39 -06:00
LICENSE Initial commit 2025-01-18 00:36:14 -07:00
next.config.ts refactor: implement modular monorepo packages 2026-06-13 13:51:18 -06:00
package.json feat(data-storage): migrate all user state from IndexedDB to server-backed storage 2026-06-14 18:13:39 -06:00
playwright.config.ts Refactor user data cleanup and TTS storage flows (#105) 2026-06-07 13:33:20 -06:00
pnpm-lock.yaml feat(data-storage): migrate all user state from IndexedDB to server-backed storage 2026-06-14 18:13:39 -06:00
pnpm-workspace.yaml refactor: implement modular monorepo packages 2026-06-13 13:51:18 -06:00
postcss.config.mjs First push 2025-01-18 04:58:57 -07:00
README.md docs(intro): clarify open-source status and multilingual support in introduction 2026-06-06 12:19:28 -06:00
tailwind.config.ts Redesign: shared UI design system + app-wide migration (#96) 2026-06-01 16:17:12 -06:00
tsconfig.json Refactor PDF parsing and rendering logic; migrate to compute-worker protocol 2026-06-12 13:43:33 -06:00
vercel.json Refactor user data cleanup and TTS storage flows (#105) 2026-06-07 13:33:20 -06:00
vitest.config.ts refactor: implement modular monorepo packages 2026-06-13 13:51:18 -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 multilingual, 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).
  • 🌐 Multilingual support — choose a document language for language-aware narration and highlighting. Available languages depend on the configured TTS provider and voice.
  • 🎧 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), built-in auth/session support, 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.