JELU 项目使用与配置指南

JELU 项目使用与配置指南

jelu Self hosted read and to-read list book tracker 项目地址: https://gitcode.com/gh_mirrors/je/jelu

1. 项目目录结构及介绍

JELU 是一个自我托管的书目追踪应用，其目录结构如下：

.
├── .github
├── .husky
├── ci
├── gradle/
│   └── wrapper/
├── screenshots
├── src
│   ├── main
│   │   ├── java
│   │   ├── resources
│   │   ├── webapp
│   │   └── kotlin
│   └── test
├── .editorconfig
├── .gitignore
├── BUILD.md
├── CHANGELOG.md
├── Dockerfile
├── LICENSE
├── README.md
├── build.gradle.kts
├── crowdin.yml
├── gradle.properties
├── gradlew
├── gradlew.bat
├── package-lock.json
├── package.json
├── settings.gradle.kts
└── ...

• src: 源代码目录，包含 Java 和 Kotlin 代码。
• screenshots: 截图目录，存放项目界面截图。
• .github: 存放 GitHub 相关的配置文件。
• .husky: 用于管理 Git 钩子的目录。
• ci: 持续集成配置文件目录。
• gradle: Gradle 构建系统相关文件。
• build.gradle.kts: Kotlin 编写的 Gradle 构建脚本。
• settings.gradle.kts: Gradle 设置文件。
• README.md: 项目说明文件。
• LICENSE: 项目许可证文件。

2. 项目的启动文件介绍

项目的启动文件通常是 gradlew 或 gradlew.bat，具体取决于你的操作系统。

• 在 Unix-like 系统（如 Linux 或 macOS）中，使用 ./gradlew bootRun 命令来启动项目。
• 在 Windows 系统中，使用 gradlew.bat 文件来启动项目。

这些脚本会使用 Gradle 构建系统来编译和运行项目，bootRun 任务会启动嵌入式服务器，并运行 JELU 应用。

3. 项目的配置文件介绍

项目的配置文件主要有以下几个：

• application.yml: Spring Boot 应用程序的配置文件，用于配置数据库连接、服务器端口等。
• build.gradle.kts: Gradle 构建脚本，可以配置项目依赖、构建任务等。
• gradle.properties: Gradle 属性文件，用于存储构建时的全局属性。

例如，如果你想更改数据库的存储位置，可以在 application.yml 文件中这样配置：

jelu:
  database:
    path: ./database

如果你想指定 fetch-ebook-metadata 可执行文件的路径，可以在 application.yml 中添加：

jelu:
  metadata:
    calibre:
      path: /usr/bin/fetch-ebook-metadata

如果需要配置 CORS（跨源资源共享），可以在 application.yml 中设置：

jelu:
  cors:
    allowed-origins:
      - "*.yourserver.org"

确保所有配置符合你的实际需求，然后可以通过启动脚本运行应用程序。

jelu Self hosted read and to-read list book tracker 项目地址: https://gitcode.com/gh_mirrors/je/jelu