danvics/openreader
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
No description
434 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 c8a35e505f feat(admin,providers,contexts): integrate react-query for admin panels and shared provider state 
Adopt @tanstack/react-query for data fetching and cache management in admin
settings, provider management, shared provider hooks, and context providers.
Replace legacy useState/useEffect data loading with react-query's useQuery and
useMutation patterns. Refactor document, rate-limit, and shared provider
contexts to use query keys and cache invalidation for consistent state across
the app. Add QueryClientProvider to root providers. Update package.json to
include react-query dependency.
2026-05-13 12:40:58 -06:00
.github build(deps): pin SeaweedFS Docker image to 4.18 for stability 2026-04-16 16:32:48 -06:00
docs-site feat(tts,config,types): migrate to providerRef/providerType model and add centralized TTS provider policy 2026-05-13 10:11:05 -06:00
drizzle feat(admin,config,ui,db): introduce runtime-editable site config and admin-managed TTS providers 2026-05-12 22:39:24 -06:00
public update(auth): enhance rate limiting with device/IP backstops and improve UI 2026-01-25 14:38:31 -07:00
scripts Fix SQL syntax for user table insert statement 2026-04-04 18:31:09 +11:00
src feat(admin,providers,contexts): integrate react-query for admin panels and shared provider state 2026-05-13 12:40:58 -06:00
tests refactor(tts,config,admin): update provider resolution logic and ordering for consistency 2026-05-13 12:08:39 -06:00
.env.example feat(admin,config,ui,db): introduce runtime-editable site config and admin-managed TTS providers 2026-05-12 22:39:24 -06:00
.gitattributes Fix check mark in SettingsModal 2025-02-11 21:31:11 -07:00
.gitignore feat(auth): implement session gatekeeping and architectural reorganization 2026-02-15 11:12:42 -07:00
.npmrc refactor: improve async state and session reliability 2026-02-15 15:13:25 -07:00
Dockerfile build(deps): pin SeaweedFS Docker image to 4.18 for stability 2026-04-16 16:32:48 -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 First push 2025-01-18 04:58:57 -07:00
eslint.config.mjs First push 2025-01-18 04:58:57 -07:00
LICENSE Initial commit 2025-01-18 00:36:14 -07:00
next.config.ts feat(auth): implement route protection and security headers 2026-02-16 19:06:24 -07:00
package.json feat(admin,providers,contexts): integrate react-query for admin panels and shared provider state 2026-05-13 12:40:58 -06:00
playwright.config.ts refactor(audio): replace ffprobe with ffmpeg for metadata extraction 2026-02-15 12:13:29 -07:00
pnpm-lock.yaml feat(admin,providers,contexts): integrate react-query for admin panels and shared provider state 2026-05-13 12:40:58 -06:00
postcss.config.mjs First push 2025-01-18 04:58:57 -07:00
README.md refactor(tts): update Replicate model defaults and voice resolution 2026-04-16 12:52:08 -06:00
tailwind.config.ts fix(tailwind): fix footer layout and tailwind config 2025-11-22 16:32:03 -07:00
tsconfig.json feat(docs): add configurable rate limiting and external docs 2026-02-10 15:11:37 -07: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

  • 🎯 Multi-provider TTS with OpenAI-compatible endpoints and cloud providers (Kokoro-FastAPI, KittenTTS-FastAPI, Orpheus-FastAPI or OpenAI, Replicate, DeepInfra).
  • 📖 Read-along playback for PDF/EPUB with sentence-aware narration.
  • ⏱️ Word-by-word highlighting via optional whisper.cpp timestamps.
  • 🛜 Sync + library import to bring docs across devices and from server-mounted folders.
  • 🗂️ Flexible storage with embedded SeaweedFS or external S3-compatible backends.
  • 🎧 Audiobook export in m4b/mp3 with resumable chapter processing.
  • 🐳 Self-host friendly with Docker, optional auth, and automatic startup migrations.

🚀 Start Here

Goal Link
Run with Docker Docker Quick Start
Deploy on Vercel Vercel Deployment
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.