Qualitis 开源项目教程
1. 项目的目录结构及介绍
Qualitis 项目的目录结构如下:
Qualitis/
├── api
│ ├── src
│ │ └── main
│ │ ├── java
│ │ └── resources
│ ├── build.gradle
│ └── Dockerfile
├── bin
│ └── start.sh
├── conf
│ └── application.yml
├── core
│ ├── src
│ │ └── main
│ │ ├── java
│ │ └── resources
│ ├── build.gradle
│ └── Dockerfile
├── docker-compose.yml
├── LICENSE
├── README.md
└── ui
├── public
└── src
目录结构介绍
-
api: 包含 API 服务的源代码和构建文件。
src/main/java
: API 服务的 Java 源代码。src/main/resources
: API 服务的资源文件。build.gradle
: API 服务的 Gradle 构建文件。Dockerfile
: API 服务的 Docker 配置文件。
-
bin: 包含启动脚本。
start.sh
: 启动 Qualitis 服务的脚本。
-
conf: 包含配置文件。
application.yml
: 主要的配置文件。
-
core: 包含核心服务的源代码和构建文件。
src/main/java
: 核心服务的 Java 源代码。src/main/resources
: 核心服务的资源文件。build.gradle
: 核心服务的 Gradle 构建文件。Dockerfile
: 核心服务的 Docker 配置文件。
-
docker-compose.yml: Docker Compose 配置文件,用于定义和运行多个 Docker 容器。
-
LICENSE: 项目的许可证文件。
-
README.md: 项目的说明文档。
-
ui: 包含前端代码。
public
: 前端公共文件。src
: 前端源代码。
2. 项目的启动文件介绍
Qualitis 项目的启动文件位于 bin
目录下,名为 start.sh
。该脚本用于启动 Qualitis 服务。
启动脚本内容
#!/bin/bash
# 启动 Qualitis 服务的脚本
# 设置环境变量
export JAVA_HOME=/path/to/java
# 启动 API 服务
nohup java -jar api/build/libs/api.jar > api.log 2>&1 &
# 启动核心服务
nohup java -jar core/build/libs/core.jar > core.log 2>&1 &
# 启动前端服务
cd ui
nohup npm start > ui.log 2>&1 &
启动步骤
- 确保 Java 环境已正确安装并配置。
- 运行
start.sh
脚本启动服务。
3. 项目的配置文件介绍
Qualitis 项目的主要配置文件位于 conf
目录下,名为 application.yml
。该文件包含了服务的各种配置选项。
配置文件内容
server:
port: 8080
spring:
datasource:
url: jdbc:mysql://localhost:3306/qualitis
username: root
password: root
qualitis:
security:
enabled: true
user:
admin:
password: admin
配置项介绍
- server.port: 服务监听的端口号。
- spring.datasource: 数据库连接配置。
url
: 数据库连接 URL。username
: 数据库用户名。password
: 数据库密码。
- qualitis.security: 安全配置。
enabled
: 是否启用安全功能。user.admin.password
: 管理员用户密码。
通过修改 application.yml
文件,可以调整 Qualitis 服务的运行参数和行为。