Lex Moulton
030a7c0823
* perf(store): decouple page turn from full library rewrite for large collections Previously every page turn triggered setLibrary() which copied the entire library array, ran refreshGroups() with MD5 hashing over all books, and caused cascading re-renders. With ~2800 books this made reading unusable. - Add hash-indexed Map to libraryStore for O(1) book lookups - Add lightweight updateBookProgress() that skips array copy and refreshGroups - Use hash index in setProgress, saveConfig, and initViewState - Batch cover URL generation with concurrency limit on library load Addresses #3714 * perf(import): replace filter()[0] with find() to short-circuit on first match * fix(store): replace Object.assign state mutation with immutable spread in setConfig * perf(persistence): remove JSON pretty-printing to reduce serialization overhead * fix(reader): stabilize debounce reference in useIframeEvents to prevent timer reset on re-render * perf(context): memoize provider values to prevent unnecessary consumer re-renders * perf(store): cache visible library to avoid refiltering on every access * perf(library): remove redundant refreshGroups call already triggered by setLibrary * perf(import): replace O(n) splice(0,0) with O(1) push for new book insertion * perf(import): defer library persistence to end of import batch instead of every 4 books * perf(library): skip full library reload on reader close since store is already in sync * fix: address PR review feedback for library perf optimizations Correctness fixes for issues found in code review: - fix(library): restore library reload on close-reader-window. Reader windows are independent Tauri webviews with their own libraryStore instance, so progress / readingStatus / move-to-front updates from the reader do not propagate to the main window. Reload from disk so the library reflects the changes the reader just persisted. - perf(import): wire BookLookupIndex into importBooks. The lookupIndex parameter on bookService.importBook had no caller, leaving the Map-based dedup path dead. Build the index once per import batch in app/library/page.tsx and thread it through appService.importBook so the O(1) dedup path is actually exercised. - perf(import): defer library save to end of batch. Add a skipSave option to libraryStore.updateBooks and call appService.saveLibraryBooks once after the entire import loop, instead of once per concurrency-4 sub-batch. - fix(store): make updateBookProgress immutable. The previous in-place mutation reused the same library array reference, bypassing Zustand change detection AND leaving the visibleLibrary cache holding stale Book references. Now slice the array, update the entry, and refresh visibleLibrary. Also make readingStatus a required parameter so future callers cannot accidentally clear it by omitting the argument. - fix(store): make saveConfig immutable. It previously mutated the Book object's progress / timestamps in place and used splice/unshift on the shared library array. Now spread to a new book object and rebuild via setLibrary. Also corrects the interface signature to return Promise<void> (the implementation was already async). - fix(store): make updateBook immutable for the same reason — it was mutating the previous-state library array before spreading. - fix(context): wrap AuthContext login/logout/refresh in useCallback. Without this, the useMemo deps array changed every render and the memo was a no-op, defeating the optimization the PR was trying to add. - fix(reader): use a ref for handlePageFlip in useMouseEvent's debounce. The empty-deps useMemo froze the first-render handler; with the ref the debounced wrapper always invokes the latest closure. Test coverage added: - library-store: immutable updateBookProgress, visibleLibrary cache refresh, deleted-book filtering, updateBooks skipSave option - book-data-store: immutable saveConfig, move-to-front correctness, visibleLibrary order, persistence behavior - import-metahash: BookLookupIndex update on new import, lookup-index consultation before scanning books array - auth-context (new file): context value identity stability across re-renders, callback identity stability - useIframeEvents (new file): debounced wheel handler dispatches to the latest handlePageFlip after re-render Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * refactor(types): move BookLookupIndex to types/book.ts Avoids the inline `import('@/services/bookService').BookLookupIndex` type annotation in types/system.ts. Both the AppService interface and the bookService implementation now import BookLookupIndex from the canonical location alongside Book. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * refactor(import): convert importBook params to options object Replace the long positional-argument list on appService.importBook (saveBook, saveCover, overwrite, transient, lookupIndex) with a single options object so callers no longer need to pad with `undefined, undefined, undefined, undefined` to reach the parameter they actually want to set. Before: await appService.importBook(file, library, undefined, undefined, undefined, undefined, lookupIndex); After: await appService.importBook(file, library, { lookupIndex }); The underlying bookService.importBook is also refactored to take an options object: required AppService callbacks (saveBookConfig, generateCoverImageUrl) are bundled with the optional flags via an ImportBookInternalOptions interface that extends the public ImportBookOptions defined in types/book.ts. All existing call sites updated to the new shape. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> --------- Co-authored-by: Huang Xin <chrox.huang@gmail.com> Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Readest
Readest is an open-source ebook reader designed for immersive and deep reading experiences. Built as a modern rewrite of Foliate, it leverages Next.js 16 and Tauri v2 to deliver a smooth, cross-platform experience across macOS, Windows, Linux, Android, iOS, and the Web.
Features • Planned Features • Screenshots • Downloads • Getting Started • Troubleshooting • Support • License
Features
| Feature | Description | Status |
|---|---|---|
| Multi-Format Support | Support EPUB, MOBI, KF8 (AZW3), FB2, CBZ, TXT, PDF | ✅ |
| Scroll/Page View Modes | Switch between scrolling or paginated reading modes. | ✅ |
| Full-Text Search | Search across the entire book to find relevant sections. | ✅ |
| Annotations and Highlighting | Add highlights, bookmarks, and notes to enhance your reading experience and use instant mode for quicker interactions. | ✅ |
| Dictionary/Wikipedia Lookup | Instantly look up words and terms when reading. | ✅ |
| Parallel Read | Read two books or documents simultaneously in a split-screen view. | ✅ |
| Customize Font and Layout | Adjust font, layout, theme mode, and theme colors for a personalized experience. | ✅ |
| Code Syntax Highlighting | Read software manuals with rich coloring of code examples. | ✅ |
| File Association and Open With | Quickly open files in Readest in your file browser with one-click. | ✅ |
| Library Management | Organize, sort, and manage your entire ebook library. | ✅ |
| OPDS/Calibre Integration | Integrate OPDS/Calibre to access online libraries and catalogs. | ✅ |
| Translate with DeepL and Yandex | From a single sentence to the entire book—translate instantly. | ✅ |
| Text-to-Speech (TTS) Support | Enjoy smooth, multilingual narration—even within a single book. | ✅ |
| Sync across Platforms | Synchronize book files, reading progress, notes, and bookmarks across all supported platforms. | ✅ |
| Sync with Koreader | Synchronize reading progress, notes, and bookmarks with Koreader devices. | ✅ |
| Accessibility | Provides full keyboard navigation and supports for screen readers such as VoiceOver, TalkBack, NVDA, and Orca. | ✅ |
| Visual & Focus Aids | Reading ruler, paragraph-by-paragraph reading mode, and speed reading features. | ✅ |
Planned Features
| Feature | Description | Priority |
|---|---|---|
| AI-Powered Summarization | Generate summaries of books or chapters using AI for quick insights. | 🛠 |
| Advanced Reading Stats | Track reading time, pages read, and more for detailed insights. | 🛠 |
| Audiobook Support | Extend functionality to play and manage audiobooks. | 🔄 |
| Handwriting Annotations | Add support for handwriting annotations using a pen on compatible devices. | 🔄 |
| In-Library Full-Text Search | Search across your entire ebook library to find topics and quotes. | 🔄 |
Stay tuned for continuous improvements and updates! Contributions and suggestions are always welcome—let's build the ultimate reading experience together. 😊
Screenshots
Downloads
Mobile Apps
Platform-Specific Downloads
- macOS / iOS / iPadOS : Search and install Readest on the App Store, also available on TestFlight for beta test (send your Apple ID to readestapp@gmail.com to request access).
- Windows / Linux / Android: Visit and download Readest at https://readest.com or the Releases on GitHub.
- Linux users can also install Readest on Flathub.
- Web: Visit and use Readest for Web at https://web.readest.com.
Requirements
- Node.js and pnpm for Next.js development
- Rust and Cargo for Tauri development
For the best experience to build Readest for yourself, use a recent version of Node.js and Rust. Refer to the Tauri documentation for details on setting up the development environment prerequisites on different platforms.
nvm install v24
nvm use v24
npm install -g pnpm
rustup update
Getting Started
To get started with Readest, follow these steps to clone and build the project.
1. Clone the Repository
git clone https://github.com/readest/readest.git
cd readest
2. Install Dependencies
# might need to rerun this when code is updated
git submodule update --init --recursive
pnpm install
# copy vendors dist libs to public directory
pnpm --filter @readest/readest-app setup-vendors
3. Verify Dependencies Installation
To confirm that all dependencies are correctly installed, run the following command:
pnpm tauri info
This command will display information about the installed Tauri dependencies and configuration on your platform. Note that the output may vary depending on the operating system and environment setup. Please review the output specific to your platform for any potential issues.
For Windows targets, “Build Tools for Visual Studio 2022” (or a higher edition of Visual Studio) and the “Desktop development with C++” workflow must be installed. For Windows ARM64 targets, the “VS 2022 C++ ARM64 build tools” and "C++ Clang Compiler for Windows" components must be installed. And make sure clang can be found in the path by adding C:\Program Files (x86)\Microsoft Visual Studio\2022\BuildTools\VC\Tools\Llvm\x64\bin for example in the environment variable Path.
4. Build for Development
# Start development for the Tauri app
pnpm tauri dev
# or start development for the Web app
pnpm dev-web
# preview with OpenNext build for the Web app
pnpm preview
For Android:
# Initialize the Android environment (run once)
rm apps/readest-app/src-tauri/gen/android
pnpm tauri android init
pnpm tauri icon ../../data/icons/readest-book.png
git checkout apps/readest-app/src-tauri/gen/android
pnpm tauri android dev
# or if you want to dev on a real device
pnpm tauri android dev --host
For iOS:
# Set up the iOS environment (run once)
pnpm tauri ios init
pnpm tauri icon ../../data/icons/readest-book.png
pnpm tauri ios dev
# or if you want to dev on a real device
pnpm tauri ios dev --host
5. Build for Production
pnpm tauri build
pnpm tauri android build
pnpm tauri ios build
Please refer to our release script if you experience any issues: https://github.com/readest/readest/blob/main/.github/workflows/release.yml
6. Setup dev environment with Nix
If you have Nix installed, you can leverage flake to enter a development shell with all the necessary dependencies:
nix develop ./ops # enter a dev shell for the web app
nix develop ./ops#ios # enter a dev shell for the ios app
nix develop ./ops#android # enter a dev shell for the android app
7. More information
Please check the wiki of this project for more information on development.
Troubleshooting
1. Readest Won’t Launch on Windows (Missing Edge WebView2 Runtime)
Symptom
- When you double-click readest.exe, nothing happens. No window appears, and Task Manager does not show the process.
- This can affect both the standard installer and the portable version.
Cause
- Microsoft Edge WebView2 Runtime is either missing, outdated, or improperly installed on your system. Readest depends on WebView2 to render the interface on Windows.
How to Fix
- Check if WebView2 is installed
- Open “Add or Remove Programs” (a.k.a. Apps & features) on Windows. Look for “Microsoft Edge WebView2 Runtime.”
- Install or Update WebView2
- Download the WebView2 Runtime directly from Microsoft: link.
- If you prefer an offline installer, download the offline package and run it as an Administrator.
- Re-run Readest
- After installing/updating WebView2, launch readest.exe again.
- If you still encounter problems, reboot your PC and try again.
Additional Tips
- If reinstalling once doesn’t work, uninstall Edge WebView2 completely, then reinstall it with Administrator privileges.
- Verify your Windows installation has the latest updates from Microsoft.
Still Stuck?
- See Issue readest/readest#358 for further details, or head over to our Discord server and open a support discussion with detailed logs of your environment and the steps you’ve taken.
2. AppImage Launches but Only Shows a Taskbar Icon
On some Arch Linux systems—especially those using Wayland—the Readest AppImage may briefly show an icon in the taskbar and then exit without opening a window.
You might see logs such as:
Could not create default EGL display: EGL_BAD_PARAMETER. Aborting...
This behavior is usually caused by compatibility issues between the bundled AppImage libraries and the system’s EGL / Wayland environment.
Workaround 1: Launch with LD_PRELOAD (recommended)
You can preload the system Wayland client library before launching the AppImage:
LD_PRELOAD=/usr/lib/libwayland-client.so /path/to/Readest.AppImage
This workaround has been confirmed to resolve the issue on affected systems.
Workaround 2: Use the Flatpak Version
If you prefer a more reliable out-of-the-box experience on Arch Linux, consider using the Flatpak build on Flathub instead. The Flatpak runtime helps avoid system library mismatches and tends to behave more consistently across different Wayland and X11 setups.
Contributors
Readest is open-source, and contributions are welcome! Feel free to open issues, suggest features, or submit pull requests. Please review our contributing guidelines before you start. We also welcome you to join our Discord community for either support or contributing guidance.
Support
If Readest has been useful to you, consider supporting its development. You can become a sponsor on GitHub, donate via Stripe, or donate with crypto. Your contribution helps us squash bugs faster, improve performance, and keep building great features.
Sponsors
License
Readest is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. See the LICENSE file for details.
The following libraries and frameworks are used in this software:
- foliate-js, which is MIT licensed.
- zip.js, which is licensed under the BSD-3-Clause license.
- fflate, which is MIT licensed.
- PDF.js, which is licensed under Apache License 2.0.
- daisyUI, which is MIT licensed.
- marked, which is MIT licensed.
- next.js, which is MIT licensed.
- react-icons, which has various open-source licenses.
- react, which is MIT licensed.
- tauri, which is MIT licensed.
The following fonts are utilized in this software, either bundled within the application or provided through web fonts:
Bitter, Fira Code, Inter, Literata, Merriweather, Noto Sans, Roboto, LXGW WenKai, MiSans, Source Han, WenQuanYi Micro Hei
We would also like to thank the Web Chinese Fonts Plan for offering open-source tools that enable the use of Chinese fonts on the web.