Find a file
2024-11-11 21:25:22 +01:00
.vscode Add wry as subpackage 2024-10-16 12:37:26 +02:00
apps/readest-app Fix notebook width interfered by bookgrid with 2024-11-11 18:26:49 +01:00
packages Add reader view settings 2024-10-30 18:09:46 +01:00
.gitignore Initialize project workspace using tauri-app and create-next-app 2024-10-12 19:42:06 +02:00
.gitmodules Remove direct dependency of pdf.js 2024-10-17 19:15:21 +02:00
.prettierignore Add a working reader page with default foliate settings 2024-10-13 00:20:48 +02:00
.prettierrc.json Add module nativeAppService 2024-10-12 20:59:44 +02:00
LICENSE Add AGPLv3 license 2024-11-11 21:25:22 +01:00
package.json Remove direct dependency of pdf.js 2024-10-17 19:15:21 +02:00
pnpm-lock.yaml Add some fonts that are good for reading 2024-11-04 13:39:38 +01:00
pnpm-workspace.yaml Add books parsing function using foliate-js 2024-10-12 21:29:54 +02:00
README.md Add readme file 2024-10-21 20:56:13 +02:00
tsconfig.json Add some fonts that are good for reading 2024-11-04 13:39:38 +01:00

Readest

Readest is an open-source ebook reading software designed for immersive and deep reading experiences. It supports EPUB and PDF document formats, and with Tauri v2, Readest is cross-platform, running seamlessly on macOS, Windows, and Linux.

Features

  • EPUB and PDF Support: Enjoy both EPUB and PDF formats, making Readest versatile for all your reading needs.
  • Cross-Platform Compatibility: Runs on macOS, Windows, and Linux with Tauri v2.
  • Immersive Reading Experience: Supports advanced reading features like note-taking, highlighting, and progress syncing.
  • Optimized Performance: Readest is lightweight, ensuring smooth performance even with large files.
  • Customizable Interface: Built with daisyUI for a modern and user-friendly UI.

Screenshots

Requirements

  • Node.js and pnpm for Next.js development
  • Rust and Cargo for Tauri development

It is recommended to use a recent version of Node.js and Rust.

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

pnpm install
# copy pdfjs-dist to Next.js public directory
pnpm --filter @readest/readest-app setup-pdfjs

3. Build the Development

pnpm tauri dev

4. 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.

License

This project is licensed under the MIT License. See the LICENSE file for details.


Happy reading with Readest!