1 Star 0 Fork 0

clevertension / Awaken

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
LGPL-3.0

Awaken

一个多端同步阅读软件:

  1. 支持桌面(Windows、macOS、理论Linux)和移动端(安卓、iOS)。
  2. 基于WebDAV的书籍管理,支持进度、笔记、书签同步,并且支持从Kindle导入笔记。
  3. 仅支持EPUB电子书,其他的可以自行转换,例如一键批量下载 Kindle 全部电子书工具 + 移除 DRM 解密插件 + 格式转换教程 (开源免费)

本项目不接任何需求,但是欢迎任何BUG修复或功能性的PR,当然那种什么代码不符合你的审美改改格式、改改先进的构建工具之类的还是算了,恕我懒得处理

技术教程见:

Awaken-基于Hybrid方案和WebDAV的全平台开源阅读软件

功能展示见视频:

应用包

详见Change Log

开发

前置需求:

  1. NodeJS v16以及以上
  2. Rust环境

首先Clone整个仓库,初始化项目:

npm run init

需要用其他包管理工具的注意加上--force,赖得处理UIKit的React版本冲突了...

接着运行开发指令:

npm run dev

然后查到本机IP地址,记DEV_URL = ${IP}:8888,分平台处理:

桌面端

在对应的操作系统上,执行一句命令即可:

npm run dev-desktop

但注意需要在非虚拟机包括WSL环境执行。

安卓端

用最新的Android Studio打开platform/android下的工程,然后修改MainActivity.kt中的字段:

private val host: String = "http://${DEV_URL}"

接着连上设备调试即可。

iOS端

XCode打开platform/ios下的工程,然后修改ContentView.swift中的字段:

let host: String = "http://${DEV_URL}"

接着连上设备调试即可。

测试

测试很简单,如果实在桌面端,需要你一开始选择一个空目录作为本地书籍存储,可以选择test/client目录,接着在主界面的设定中,填入以下配置:

  1. 地址:http://${IP}:8889/dav/
  2. 用户名:dtysky
  3. 密码:114514

确认后即连接到本地调试服务器,接下来你可以在test目录中找到一些测试用书籍,来测试添加、删除、阅读等等功能。本地测试服务器的文件落在了test/server/dav下。

发布

发布首先要执行指令:

npm run build

然后分平台处理:

桌面端

直接执行:

npm run release-desktop

即可,但同样需要在非虚拟机包括WSL环境执行。如果只发布桌面端,也可以直接执行:

npm run release

产物在platforms/desktop/target/release/bundle中。

安卓端

打开项目工程,在Build -> Select Build Variants窗口,设置选择为release模式,然后Build -> Generate Signed Build or APK即可,可能需要重新生成签名文件。

产物在platforms/android/app/release中。

iOS端

打开项目工程,构建的schema选择release即可。

todo

  1. 移动端,默认选择文本后的弹窗行为。
  2. 书籍列表分页。
  3. 书籍列表搜索。

Copyright

Copyright © 2022, 戴天宇, Tianyu Dai (dtysky < dtysky@outlook.com >). All Rights Reserved.
This project is free software and released under the GNU Lesser General Public License (LGPL).

GNU LESSER GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/> Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. This version of the GNU Lesser General Public License incorporates the terms and conditions of version 3 of the GNU General Public License, supplemented by the additional permissions listed below. 0. Additional Definitions. As used herein, "this License" refers to version 3 of the GNU Lesser General Public License, and the "GNU GPL" refers to version 3 of the GNU General Public License. "The Library" refers to a covered work governed by this License, other than an Application or a Combined Work as defined below. An "Application" is any work that makes use of an interface provided by the Library, but which is not otherwise based on the Library. Defining a subclass of a class defined by the Library is deemed a mode of using an interface provided by the Library. A "Combined Work" is a work produced by combining or linking an Application with the Library. The particular version of the Library with which the Combined Work was made is also called the "Linked Version". The "Minimal Corresponding Source" for a Combined Work means the Corresponding Source for the Combined Work, excluding any source code for portions of the Combined Work that, considered in isolation, are based on the Application, and not on the Linked Version. The "Corresponding Application Code" for a Combined Work means the object code and/or source code for the Application, including any data and utility programs needed for reproducing the Combined Work from the Application, but excluding the System Libraries of the Combined Work. 1. Exception to Section 3 of the GNU GPL. You may convey a covered work under sections 3 and 4 of this License without being bound by section 3 of the GNU GPL. 2. Conveying Modified Versions. If you modify a copy of the Library, and, in your modifications, a facility refers to a function or data to be supplied by an Application that uses the facility (other than as an argument passed when the facility is invoked), then you may convey a copy of the modified version: a) under this License, provided that you make a good faith effort to ensure that, in the event an Application does not supply the function or data, the facility still operates, and performs whatever part of its purpose remains meaningful, or b) under the GNU GPL, with none of the additional permissions of this License applicable to that copy. 3. Object Code Incorporating Material from Library Header Files. The object code form of an Application may incorporate material from a header file that is part of the Library. You may convey such object code under terms of your choice, provided that, if the incorporated material is not limited to numerical parameters, data structure layouts and accessors, or small macros, inline functions and templates (ten or fewer lines in length), you do both of the following: a) Give prominent notice with each copy of the object code that the Library is used in it and that the Library and its use are covered by this License. b) Accompany the object code with a copy of the GNU GPL and this license document. 4. Combined Works. You may convey a Combined Work under terms of your choice that, taken together, effectively do not restrict modification of the portions of the Library contained in the Combined Work and reverse engineering for debugging such modifications, if you also do each of the following: a) Give prominent notice with each copy of the Combined Work that the Library is used in it and that the Library and its use are covered by this License. b) Accompany the Combined Work with a copy of the GNU GPL and this license document. c) For a Combined Work that displays copyright notices during execution, include the copyright notice for the Library among these notices, as well as a reference directing the user to the copies of the GNU GPL and this license document. d) Do one of the following: 0) Convey the Minimal Corresponding Source under the terms of this License, and the Corresponding Application Code in a form suitable for, and under terms that permit, the user to recombine or relink the Application with a modified version of the Linked Version to produce a modified Combined Work, in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source. 1) Use a suitable shared library mechanism for linking with the Library. A suitable mechanism is one that (a) uses at run time a copy of the Library already present on the user's computer system, and (b) will operate properly with a modified version of the Library that is interface-compatible with the Linked Version. e) Provide Installation Information, but only if you would otherwise be required to provide such information under section 6 of the GNU GPL, and only to the extent that such information is necessary to install and execute a modified version of the Combined Work produced by recombining or relinking the Application with a modified version of the Linked Version. (If you use option 4d0, the Installation Information must accompany the Minimal Corresponding Source and Corresponding Application Code. If you use option 4d1, you must provide the Installation Information in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source.) 5. Combined Libraries. You may place library facilities that are a work based on the Library side by side in a single library together with other library facilities that are not Applications and are not covered by this License, and convey such a combined library under terms of your choice, if you do both of the following: a) Accompany the combined library with a copy of the same work based on the Library, uncombined with any other library facilities, conveyed under the terms of this License. b) Give prominent notice with the combined library that part of it is a work based on the Library, and explaining where to find the accompanying uncombined form of the same work. 6. Revised Versions of the GNU Lesser General Public License. The Free Software Foundation may publish revised and/or new versions of the GNU Lesser General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Library as you received it specifies that a certain numbered version of the GNU Lesser General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that published version or of any later version published by the Free Software Foundation. If the Library as you received it does not specify a version number of the GNU Lesser General Public License, you may choose any version of the GNU Lesser General Public License ever published by the Free Software Foundation. If the Library as you received it specifies that a proxy can decide whether future versions of the GNU Lesser General Public License shall apply, that proxy's public statement of acceptance of any version is permanent authorization for you to choose that version for the Library.

简介

暂无描述 展开 收起
LGPL-3.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
1
https://gitee.com/clevertension/Awaken.git
git@gitee.com:clevertension/Awaken.git
clevertension
Awaken
Awaken
master

搜索帮助