HyDePanel 项目安装与使用教程

1. 项目目录结构及介绍

HyDePanel 项目的目录结构如下：

HyDePanel/
├── bin/                       # 项目可执行文件目录
├── config/                    # 配置文件目录
│   └── config.json            # 项目配置文件
├── docs/                      # 项目文档目录
├── lib/                       # 项目核心库文件目录
├── scripts/                   # 项目脚本目录
│   └── start.sh               # 项目启动脚本
├── src/                       # 项目源代码目录
│   ├── main.py                # 项目主程序文件
│   └── ...
├── tests/                     # 测试代码目录
└── README.md                  # 项目说明文件

• bin/：存放项目的可执行文件。
• config/：存放项目的配置文件。
• docs/：存放项目的文档资料。
• lib/：存放项目的核心库文件。
• scripts/：存放项目相关的脚本文件，如启动脚本。
• src/：存放项目的源代码文件，main.py 是项目的主程序文件。
• tests/：存放项目的测试代码。
• README.md：项目的说明文件，包含了项目的基本信息和使用方法。

2. 项目的启动文件介绍

项目的启动文件位于 scripts/start.sh。该脚本负责启动 HyDePanel 服务。以下是启动脚本的基本内容：

#!/bin/bash

# 设置项目路径
PROJECT_PATH="/path/to/HyDePanel"

# 进入项目目录
cd "$PROJECT_PATH"

# 启动项目
python src/main.py

在终端中执行以下命令启动项目：

chmod +x scripts/start.sh
./scripts/start.sh

确保已经正确设置了 PROJECT_PATH 变量，使其指向 HyDePanel 项目的实际路径。

3. 项目的配置文件介绍

项目的配置文件为 config/config.json。该文件包含了项目运行时所需的各种配置信息。以下是配置文件的一个示例：

{
  "port": 8080,
  "database": {
    "host": "localhost",
    "port": 3306,
    "user": "root",
    "password": "password",
    "name": "hydepanel"
  }
}

• "port"：项目运行的端口号。
• "database"：数据库配置信息，包括数据库地址、端口、用户名、密码和数据库名称。

确保在启动项目之前，已经正确配置了 config.json 文件中的所有信息。