Readest 项目使用教程

1. 项目的目录结构及介绍

Readest 项目是一个现代化的电子书阅读器，其目录结构如下：

readest/
├── .github/
├── .vscode/
├── apps/
│   └── readest-app/
├── data/
├── fastlane/
│   └── metadata/
│       └── android/
│           └── en-US/
├── ops/
├── packages/
├── .editorconfig/
├── .gitignore/
├── .gitmodules/
├── .prettierignore/
├── .prettierrc.json/
├── Cargo.lock/
├── Cargo.toml/
├── Dockerfile/
├── LICENSE/
├── README.md/
├── package.json/
├── pnpm-lock.yaml/
├── pnpm-workspace.yaml/
└── tsconfig.json/

• .github/: 存放 GitHub 的工作流和模板文件。
• .vscode/: 存放 Visual Studio Code 的项目配置文件。
• apps/: 包含主要的 Readest 应用程序。
• data/: 存放项目数据。
• fastlane/: 包含自动化构建和发布流程的配置文件。
• ops/: 包含运维相关的脚本和配置。
• packages/: 存放项目的依赖包。
• .editorconfig/: 定义代码编辑器的配置。
• .gitignore/: 指定 Git 忽略的文件和目录。
• .gitmodules/: 定义 Git 子模块。
• .prettierignore/: 指定 prettier 忽略的文件。
• .prettierrc.json/: 定义 prettier 的配置。
• Cargo.lock/: Rust 项目的依赖锁定文件。
• Cargo.toml/: Rust 项目的依赖配置文件。
• Dockerfile/: 定义 Docker 容器的构建过程。
• LICENSE/: 项目的许可证文件。
• README.md/: 项目的说明文档。
• package.json/: Node.js 项目的配置文件。
• pnpm-lock.yaml/: pnpm 的依赖锁定文件。
• pnpm-workspace.yaml/: pnpm 的工作空间配置文件。
• tsconfig.json/: TypeScript 的配置文件。

2. 项目的启动文件介绍

Readest 项目的启动主要依赖于以下几个文件：

• pnpm tauri dev: 用于启动 Tauri 应用的开发环境。
• pnpm dev-web: 用于启动 Web 应用的开发环境。
• pnpm tauri android dev: 用于在 Android 设备上启动 Tauri 应用的开发环境。
• pnpm tauri ios dev: 用于在 iOS 设备上启动 Tauri 应用的开发环境。

3. 项目的配置文件介绍

项目的配置文件主要包括：

• .editorconfig: 定义了代码编辑器的基本配置，如缩进风格、换行符等。
• .prettierrc.json: 定义了 prettier 的代码格式化配置。
• tsconfig.json: 定义了 TypeScript 的编译选项和配置。
• Cargo.toml: 定义了 Rust 项目的依赖和构建配置。
• package.json: 定义了 Node.js 项目的依赖、脚本和配置。

通过这些配置文件，可以确保项目在不同开发环境和平台上的一致性和稳定性。