8.8 KiB
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 and Tauri v2 to offer a seamless cross-platform experience on macOS, Windows, Linux, with support for Web and mobile platforms coming soon.
Features • Planned Features • Screenshots • Getting Started • Contributing • Contributors • License
Features
| Feature | Description | Status |
|---|---|---|
| Multi-Format Support | Support EPUB, MOBI, KF8 (AZW3), FB2, CBZ, PDF (experimental) | ✅ |
| 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. | ✅ |
| Excerpt Text for Note-Taking | Easily excerpt text from books for detailed notes and analysis. | ✅ |
| Dictionary/Wikipedia Lookup | Instantly look up words and terms when reading. | ✅ |
| Translate with DeepL | Translate selected text instantly using DeepL for accurate translations. | ✅ |
| 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. | ✅ |
| File Association and Open With | Quickly open files in Readest in your file browser with one-click. | ✅ |
Planned Features
| Feature | Description | Priority |
|---|---|---|
| Support Web, iOS, and Android | Expand the APP to work on web browsers, iOS, and Android devices. | 🛠 |
| Sync Across Platforms | Synchronize reading progress, notes, and bookmarks across all supported platforms. | 🛠 |
| Sync with Koreader | Synchronize reading progress, notes, and bookmarks with Koreader devices. | 🔄 |
| Library Management | Organize, sort, and manage your entire ebook library. | 🔄 |
| OPDS/Calibre Support | Integrate OPDS/Calibre to access online libraries and catalogs. | 🔄 |
| Text-to-Speech (TTS) Support | Enable text-to-speech functionality for a more accessible reading experience. | 🔄 |
| Audiobook Support | Extend functionality to play and manage audiobooks. | 🔄 |
| Handwriting Annotations | Add support for handwriting annotations using a pen on compatible devices. | 🔄 |
| Advanced Reading Stats | Track reading time, pages read, and more for detailed insights. | 🔄 |
| In-Library Full-Text Search | Search across your entire ebook library to find topics and quotes. | 🔄 |
| AI-Powered Summarization | Generate summaries of books or chapters using AI for quick insights. | 🔄 |
Stay tuned for continuous improvements and updates! Contributions and suggestions are always welcome—let's build the ultimate reading experience together. 😊
Screenshots
Requirements
- Node.js and pnpm for Next.js development
- Rust and Cargo for Tauri development
For the best experience, 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 v22
nvm use v22
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/chrox/readest.git
cd readest
git submodule update --init --recursive
2. Install Dependencies
npm install -g pnpm
pnpm install
# copy pdfjs-dist to Next.js public directory
pnpm --filter @readest/readest-app setup-pdfjs
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 the Development
pnpm tauri dev
5. Build for Production
pnpm tauri build
Contributing
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.
Contributors
License
Readest is distributed under the AGPL-3.0 License. See the LICENSE file for details.