非常好用的开源电子书阅读器

环境要求

• Node.js 和 pnpm 用于 Next.js 开发
• Rust 和 Cargo 用于 Tauri 开发

为了获得自行构建 Readest 的最佳体验，请使用较新版本的 Node.js 和 Rust。有关在不同平台上设置开发环境先决条件的详细信息，请参阅 Tauri 文档。

nvm install v22nvm use v22npm install -g pnpmrustup update

快速开始

要开始使用 Readest，请按照以下步骤克隆并构建项目。

1. 克隆仓库

git clone https://github.com/readest/readest.gitcd readest

2. 安装依赖

# 代码更新时可能需要重新运行此命令git submodule update --init --recursivepnpm install# 将供应商的 dist 库复制到公共目录pnpm --filter @readest/readest-app setup-vendors

3. 验证依赖安装

要确认所有依赖都已正确安装，请运行以下命令：

pnpm tauri info

此命令将显示有关您平台上已安装的 Tauri 依赖项和配置的信息。请注意，输出可能因操作系统和环境设置而异。请针对您的平台检查输出，以发现任何潜在问题。

对于 Windows 目标，必须安装 "Build Tools for Visual Studio 2022"（或更高版本的 Visual Studio）和 "Desktop development with C++" 工作负载。对于 Windows ARM64 目标，必须安装 "VS 2022 C++ ARM64 build tools" 和 "C++ Clang Compiler for Windows" 组件。并确保 clang 可以在路径中找到，例如将 C:\Program Files (x86)\Microsoft Visual Studio\2022\BuildTools\VC\Tools\Llvm\x64\bin 添加到环境变量 Path 中。

4. 构建开发版本

# 启动 Tauri 应用的开发模式pnpm tauri dev# 或启动 Web 应用的开发模式pnpm dev-web# 使用 OpenNext 构建预览 Web 应用pnpm preview

对于 Android：

# 初始化 Android 环境（仅需运行一次）rm apps/readest-app/src-tauri/gen/androidpnpm tauri android initgit checkout apps/readest-app/src-tauri/gen/androidpnpm tauri android dev# 或者如果您想在真实设备上开发pnpm tauri android dev --host

对于 iOS：

# 设置 iOS 环境（仅需运行一次）pnpm tauri ios initpnpm tauri ios dev# 或者如果您想在真实设备上开发pnpm tauri ios dev --host

5. 构建生产版本

pnpm tauri buildpnpm tauri android buildpnpm tauri ios build

如果您遇到任何问题，请参考我们的发布脚本： https://github.com/readest/readest/blob/main/.github/workflows/release.yml

6. 使用 Nix 设置开发环境

如果您安装了 Nix，可以利用 flake 进入包含所有必要依赖的开发 shell：