HFish 项目安装与使用教程

HFish 项目安装与使用教程

1. 项目目录结构及介绍

HFish 项目的目录结构如下：

HFish/
├── admin/
├── core/
├── db/
├── error/
├── images/
├── logs/
├── static/
├── utils/
├── view/
├── web/
│   └── github/
├── .gitattributes
├── .gitignore
├── LICENSE
├── README.md
├── config.ini
├── go.mod
├── go.sum
└── main.go

目录介绍：

• admin/: 管理员相关文件。
• core/: 核心功能模块。
• db/: 数据库相关文件。
• error/: 错误处理相关文件。
• images/: 图片资源文件。
• logs/: 日志文件。
• static/: 静态资源文件。
• utils/: 工具类文件。
• view/: 视图文件。
• web/: Web 相关文件。
• .gitattributes: Git 属性配置文件。
• .gitignore: Git 忽略文件配置。
• LICENSE: 项目许可证文件。
• README.md: 项目介绍文件。
• config.ini: 项目配置文件。
• go.mod: Go 模块依赖文件。
• go.sum: Go 模块依赖校验文件。
• main.go: 项目启动文件。

2. 项目启动文件介绍

项目的启动文件是 main.go。该文件负责初始化项目并启动服务。以下是 main.go 的基本结构：

package main

import (
    // 导入必要的包
)

func main() {
    // 初始化配置
    // 启动服务
}

主要功能：

• 初始化项目配置。
• 启动 HTTP 服务。
• 加载必要的模块和插件。

3. 项目配置文件介绍

项目的配置文件是 config.ini。该文件包含了项目的各种配置选项，如数据库连接、服务端口、API 密钥等。以下是 config.ini 的基本结构：

[database]
host = localhost
port = 3306
user = root
password = root
dbname = hfish

[server]
port = 9001

[api]
sec_key = 9cbf8a4dcb8e30682b927f352d6559a0

配置项介绍：

• [database]: 数据库连接配置。
  • host: 数据库主机地址。
  • port: 数据库端口。
  • user: 数据库用户名。
  • password: 数据库密码。
  • dbname: 数据库名称。
• [server]: 服务配置。
  • port: 服务监听端口。
• [api]: API 配置。
  • sec_key: API 安全密钥。

通过修改 config.ini 文件，可以调整项目的运行参数，以适应不同的环境和需求。