Hound项目使用教程

1. 项目目录结构及介绍

Hound项目的目录结构如下：

hound/
├── compose.env
├── docker-compose.yml
├── server/
│   ├── .env
│   ├── main.go
│   ├── ...
│   └── go.mod
├── web/
│   ├── src/
│   │   ├── config.json
│   │   ├── ...
│   │   └── index.html
│   ├── package.json
│   └── ...
├── .gitattributes
├── .gitignore
├── LICENSE
├── README.md
└── ...

• server/：存放后端的Go语言代码和相关文件。
• web/：存放前端代码，使用TypeScript编写，并包含必要的静态文件。
• docker-compose.yml：用于定义和运行多容器Docker应用。
• compose.env：存储环境变量，如API密钥和数据库连接信息。
• .gitattributes：定义如何处理项目中的文件。
• .gitignore：指定Git应该忽略的文件和目录。
• LICENSE：项目使用的开源协议，GPL-3.0。
• README.md：项目说明文件。

2. 项目的启动文件介绍

项目的启动主要涉及前端和后端两个部分。

后端启动

后端使用Go语言编写，启动后端服务的步骤如下：

1. 进入server/目录。
2. 运行go build命令编译代码。
3. 运行编译后的可执行文件。

前端启动

前端使用TypeScript编写，启动前端服务的步骤如下：

1. 进入web/目录。
2. 运行npm install安装依赖。
3. 运行npm run start启动开发服务器。

3. 项目的配置文件介绍

项目使用两个主要的配置文件：

• server/.env：后端环境变量配置文件，用于配置数据库连接信息、API密钥等敏感信息。
• web/src/config.json：前端配置文件，用于配置后端服务地址等。

确保在server/.env中设置了正确的数据库连接和API密钥。如果更改了数据库的用户名或密码，也需要在docker-compose.yml中更新数据库的连接字符串。

在前端的config.json文件中，可以配置后端服务的地址，例如：

{
  "server_host": "http://localhost:8080"
}

确保这个地址与实际后端服务的地址一致。