read 的安装和配置教程

1. 项目基础介绍和主要编程语言

read 是一个开源的阅读应用后端项目，它旨在提供一个简单、易用的服务端解决方案，以支持全移动端的阅读应用。该应用适配了手机和大屏设备，确保用户在使用不同设备时都能获得一致的体验。项目的主要编程语言为 Kotlin，同时使用了 Java 和 JavaScript。

2. 项目使用的关键技术和框架

项目使用的关键技术和框架包括：

• Kotlin/Java: 作为后端开发的主要编程语言。
• SQLite/MySQL: 作为数据库存储，默认使用 SQLite，但支持修改为 MySQL。
• Spring Boot: 用于快速开发 Spring 应用程序。
• WebSocket: 用于实时数据传输。
• GitHub Copilot: AI 驱动的编码辅助工具，可帮助开发者提高编码效率。
• Docker: 用于容器化部署，简化部署过程。

3. 安装和配置准备工作

在开始安装和配置之前，请确保您已经准备好以下环境：

• 操作系统: Linux, Windows 或 macOS。
• Java Development Kit (JDK): 版本要求 8 或以上。
• Docker: 用于容器化部署。
• MySQL (可选): 如果需要使用 MySQL 数据库，请确保已经安装和配置好。

4. 安装步骤

步骤 1: 克隆项目

首先，您需要将项目克隆到本地计算机。由于不能使用链接，请手动将以下命令复制到终端：

git clone https://github.com/autobcb/read.git

步骤 2: 准备配置文件

进入项目目录后，您需要准备配置文件 conf.yml。该文件用于配置后端管理账号密码等信息。请根据您的需求修改 conf.yml 文件中的相应字段。

步骤 3: 构建项目

使用以下命令构建项目：

./gradlew build

步骤 4: 启动服务

构建完成后，您可以使用以下命令启动服务：

java -jar build/libs/read.jar

步骤 5: Docker 部署 (可选)

如果您希望使用 Docker 进行部署，请执行以下命令：

docker run -tid  -e TZ=Asia/Shanghai --name read  -v /root/read:/app -p 8080:8080 --restart=always docker-0.unsee.tech/bitnami/java java -jar /app/read.jar

步骤 6: MySQL 集成 (可选)

如果您选择使用 MySQL 数据库，请参考 mysqlconf.yml 文件修改 conf.yml 中的数据库配置。

完成以上步骤后，您的 read 项目应该已经成功安装和配置。您可以访问 http://ip:8080/admin 和 http://ip:8080/ 来访问后台和前端界面。