HOMER App 项目使用指南

1. 项目目录结构及介绍

HOMER App 是一个基于 Go 语言的开源 Web 应用程序，用于 HEP/HOMER 7.7+ 堆栈的前端和 API 服务器。项目的目录结构如下：

• auth/: 存放身份验证相关的代码。
• config/: 包含配置文件和相关配置代码。
• controller/v1/: RESTful API 控制器，处理 HTTP 请求。
• data/service: 数据服务层，处理数据逻辑。
• docker/: 存放 Docker 相关的配置文件和脚本。
• etc/: 系统配置文件。
• log/: 日志文件存放位置。
• migration/: 数据库迁移脚本。
• model/: 数据库模型定义。
• network/response: 网络响应处理。
• router/v1/: 路由配置，定义 URL 路径和对应的处理函数。
• scripts/: 脚本文件，用于各种任务。
• sqlparser/: SQL 解析器代码。
• system/: 系统级代码。
• utils/: 工具类和函数。
• .github/: GitHub Actions 工作流文件。
• .gitignore: Git 忽略文件列表。
• CONFIGURE.md: 配置指南文档。
• Dockerfile: Docker 构建文件。
• LICENSE: 项目许可证文件。
• Makefile: 构建和编译项目的 Makefile 文件。
• README.md: 项目介绍和说明文件。
• go.mod: Go 依赖管理文件。
• go.sum: Go 依赖总和文件。
• homer-app.service: 系统服务文件（如 systemd）。
• homer-app.yaml: Kubernetes 配置文件。
• main.go: 项目的主入口文件。
• swagger.json: Swagger API 文档。
• version.go: 版本信息代码。

2. 项目的启动文件介绍

项目的启动文件是 main.go。这个文件中包含了初始化应用程序的主要逻辑，包括数据库连接、配置加载、路由设置以及启动 Web 服务器。

以下是 main.go 文件的一个简化示例：

package main

import (
    "github.com/sipcapture/homer-app/cmd"
)

func main() {
    cmd.Execute()
}

在实际的项目中，cmd.Execute() 函数会处理命令行参数，并根据这些参数启动相应的功能，比如启动 Web 服务器、执行数据库迁移等。

3. 项目的配置文件介绍

项目的配置文件通常位于 etc/webapp_config.json。这个文件包含了应用程序运行所需的各种配置信息，例如数据库连接信息、服务端口、日志设置等。

以下是一个配置文件的示例：

{
    "server": {
        "port": 8080,
        "host": "0.0.0.0"
    },
    "database": {
        "host": "localhost",
        "port": "5432",
        "user": "homer_user",
        "password": "homer_password",
        "dbname": "homer_data"
    },
    "logging": {
        "level": "INFO",
        "output": "stdout"
    }
}

在运行应用程序之前，需要确保配置文件中的所有设置都是正确的，以避免启动时出现错误。如果配置文件不在默认目录，可以使用 -webapp-config-path 参数来指定配置文件的位置。