diff --git a/apps/koodo-reader/README.md b/apps/koodo-reader/README.md new file mode 100644 index 00000000..4842fe5a --- /dev/null +++ b/apps/koodo-reader/README.md @@ -0,0 +1,136 @@ +
+ +简体中文 | [Português](https://github.com/troyeguo/koodo-reader/blob/master/README_pt.md) | [English](https://github.com/troyeguo/koodo-reader/blob/master/README.md) + +
+ +
+ +
+ +

+ Koodo Reader +

+ +

+ 一个跨平台的电子书阅读器 +

+ +
+ +[下载客户端](https://koodo.960960.xyz/zh) | [在线预览](https://reader.960960.xyz) | [开发计划](https://troyeguo.notion.site/215baeda57804fd29dbb0e91d1e6a021?v=360c00183d944b598668f34c255edfd7) | [帮助文档](https://troyeguo.notion.site/Koodo-Reader-0c9c7ccdc5104a54825dfc72f1c84bea) + +
+ + +## 特色 + +- 支持阅读格式： + - EPUB (**.epub**) + - 扫描文档 (**.pdf**) + - Kindle (**.azw3**, **.mobi**, **.azw**) + - 纯文本 (**.txt**) + - 漫画 (**.cbr**, **.cbz**, **.cbt**, **.cb7**) + - 富文本 (**.md**, **.docx**) + - FB2 (**.fb2**) + - 超文本 (**.html**, **.xml**, **.xhtml**, **.mhtml**, **.htm**, **.htm**) +- 支持 **Windows**，**macOS**，**Linux** 和 **网页版** +- 备份数据到 **Dropbox** 和 **Webdav** +- 自定义源文件夹，利用 OneDrive、百度网盘、iCloud、Dropbox 等进行多设备同步 +- 双页模式，单页模式，滚动模式 +- 听书功能，翻译功能，触控屏支持，批量导入图书 +- 支持目录，书签，笔记，高亮，书架，标签 +- 自定义字体，字体大小，行间距，段落间距，阅读背景色，文字颜色，屏幕亮度，文字下划线、斜体、文字阴影、字体粗细 +- 黑夜模式和主题色设置 + +## 使用方法 + +- 桌面端： + - 稳定版 (推荐下载)：[官网](https://koodo.960960.xyz/zh)（感谢 [@Stille](https://www.ioiox.com/donate.html) 提供下载加速服务） + - 开发版：[Github Release](https://github.com/troyeguo/koodo-reader/releases/latest) （包含新功能和 bug 修复，但也可能引入更多未知 bug） +- 网页版：[前往](https://reader.960960.xyz) +- 使用 Scoop 安装： + +```shell +scoop bucket add extras +scoop install dorado/koodo-reader +``` + +- 使用 Winget 安装： + +```shell +winget install -e AppbyTroye.KoodoReader +``` + +- 使用 Homebrew 安装： + +```shell +brew install --cask koodo-reader +``` + +- 使用 Docker 安装： + +```bash +docker-compose up -d +``` + +- 使用 Flathub 安装： + +```shell +flatpak install flathub io.github.troyeguo.koodo-reader +flatpak run io.github.troyeguo.koodo-reader +``` + +Download on Flathub + +## 预览 + +
+ + +
+ +## 截图 + +
+ 列表模式 + + 封面模式 + + 阅读菜单 + + 备份和恢复 + + 黑夜模式和主题色 + + 笔记管理 + +
+ +## 运行源码 + +请确保您电脑已配置好 yarn，git 的运行环境。 + +1. 将项目源码下载到本地 + + ``` + git clone https://github.com/troyeguo/koodo-reader.git + ``` + +2. cd 到项目文件夹，运行以下代码进入客户端模式 + + ``` + yarn + yarn dev + ``` + +3. 运行以下代码进入网页模式 + + ``` + yarn + yarn start + ``` + +## 贡献翻译 + +您可以通过 Koodo Reader 的[在线翻译工具](https://poeditor.com/join/project?hash=fk4qbQTlsk)，完善现有翻译，也可以添加新的语言。 \ No newline at end of file diff --git a/apps/koodo-reader/data.yml b/apps/koodo-reader/data.yml new file mode 100644 index 00000000..bce427a0 --- /dev/null +++ b/apps/koodo-reader/data.yml @@ -0,0 +1,20 @@ +name: Koodo Reader +tags: + - 工具 +title: 一个跨平台的电子书阅读器 +type: 工具 +description: 一个跨平台的电子书阅读器 +additionalProperties: + key: koodo-reader + name: Koodo Reader + tags: + - Tool + shortDescZh: 一个跨平台的电子书阅读器 + shortDescEn: A cross-platform ebook reader + type: tool + crossVersionUpdate: true + limit: 0 + recommend: 0 + website: https://koodo.960960.xyz + github: https://github.com/troyeguo/koodo-reader + document: https://troyeguo.notion.site/Koodo-Reader-0c9c7ccdc5104a54825dfc72f1c84bea diff --git a/apps/koodo-reader/latest/.env.sample b/apps/koodo-reader/latest/.env.sample new file mode 100644 index 00000000..6f23c245 --- /dev/null +++ b/apps/koodo-reader/latest/.env.sample @@ -0,0 +1,2 @@ +CONTAINER_NAME="koodo-reader" +PANEL_APP_PORT_HTTP="40146" diff --git a/apps/koodo-reader/latest/data.yml b/apps/koodo-reader/latest/data.yml new file mode 100644 index 00000000..c48a7adf --- /dev/null +++ b/apps/koodo-reader/latest/data.yml @@ -0,0 +1,10 @@ +additionalProperties: + formFields: + - default: 40146 + edit: true + envKey: PANEL_APP_PORT_HTTP + labelEn: Port + labelZh: 端口 + required: true + rule: paramPort + type: number diff --git a/apps/koodo-reader/latest/docker-compose.yml b/apps/koodo-reader/latest/docker-compose.yml new file mode 100644 index 00000000..9dd03bf2 --- /dev/null +++ b/apps/koodo-reader/latest/docker-compose.yml @@ -0,0 +1,16 @@ +version: '3' +services: + koodo-reader: + container_name: ${CONTAINER_NAME} + restart: always + networks: + - 1panel-network + ports: + - "${PANEL_APP_PORT_HTTP}:80" + image: liwangsheng/koodo-reader:latest + labels: + createdBy: "Apps" + +networks: + 1panel-network: + external: true diff --git a/apps/koodo-reader/logo.png b/apps/koodo-reader/logo.png new file mode 100644 index 00000000..ae34559c Binary files /dev/null and b/apps/koodo-reader/logo.png differ