Skip to content

PoxenStudio/MyReader

Repository files navigation

MyReader: My Reader for MyBooks

GitHub License GitHub stars GitHub commit activity

logo

Introduction

当前项目是基于Readest实现的个人书库MyBooks阅读客户端,不是MyBooks的管理工具,只提供用户登录、个人账号管理及多种形式的搜索及查询功能、从MyBooks中下载并阅读的功能、将阅读数据同步到MyBooks等功能。

MyReader UI

文档MyReader API中为MyBooks的API定义。

主要变更包括:

  1. 实现MyBooks账户的登录与注销功能。
  2. 在UI首页增加MyBooks提供的不同方式的书籍分类,包括分类、标签、作者、出版社、语言、系列和评分等。 通过UI左侧增加导航菜单实现分类导航,然后调用MyBooks的接口展示所使用的分类列表和书籍列表。
  3. 增加对MyBooks书籍的下载及阅读支持。 书籍信息分为本地和云端两类, 但不需要做自动同步的操作。之前的多云端同步的功能需要禁用,只做为MyBooks中书籍下载和本地阅读的功能。
  4. Library中的搜索区分当前书架为本地图书时即搜索本地图书,其它情况则为使用MyBooks的搜索接口进行搜索,并使用书架展示。
  5. 支持将阅读数据同步到MyBooks。

安装运行

在Release中下载对应平台的安装包进行安装。所有安装包都没有进行签名,macOS下需要下载后对下载的dmg执行如下命令:

sudo xattr -rd com.apple.quarantine MyReader-<xxxxxxxxxxx>.dmg

Development

请按照以下步骤克隆并构建项目。

1. 克隆仓库

git clone https://github.com/poxenstudio/myreader.git
cd myreader

2. 安装依赖

# 代码更新后可能需要重新运行此命令
git submodule update --init --recursive
# 如果submodule目录为空,可以增加参数重试: --force --checkout
pnpm install
# 将 vendor 库复制到 public 目录
pnpm --filter @poxenstudio/myreader setup-vendors

3. 验证依赖安装

运行以下命令确认所有依赖已正确安装:

pnpm tauri info

此命令将显示已安装的 Tauri 依赖和平台配置信息。输出可能因操作系统和环境配置不同而有所差异,请查看针对您平台的输出以发现潜在问题。

对于 Windows 目标平台,必须安装 "Visual Studio 2022 生成工具"(或更高版本)及 "使用 C++ 的桌面开发" 工作负载。对于 Windows ARM64 目标平台,必须安装 "VS 2022 C++ ARM64 生成工具" 和 "C++ Clang Compiler for Windows" 组件。同时确保 clang 可在 PATH 中找到,例如通过将 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 app/src-tauri/gen/android
pnpm tauri android init
pnpm tauri icon ../../data/icons/myreader-book.png
git checkout app/src-tauri/gen/android

pnpm tauri android dev
# 或在真机上开发
pnpm tauri android dev --host

iOS:

# 设置 iOS 环境(运行一次)
pnpm tauri ios init
pnpm tauri icon ../../data/icons/myreader-book.png

pnpm tauri ios dev
# 或在真机上开发
pnpm tauri ios dev --host

5. 生产环境构建

pnpm tauri build
pnpm tauri android build
pnpm tauri ios build

6. 使用 Nix 设置开发环境

如果已安装 Nix,可以利用 flake 进入包含所有必要依赖的开发 shell:

nix develop ./ops  # 进入 Web 应用开发 shell
nix develop ./ops#ios # 进入 iOS 应用开发 shell
nix develop ./ops#android # 进入 Android 应用开发 shell

About

个人书库MyBooks定制阅读器

Topics

Resources

License

Contributing

Security policy

Stars

10 stars

Watchers

0 watching

Forks

Packages

 
 
 

Contributors