Gaea 项目使用教程

Gaea 项目使用教程

1. 项目的目录结构及介绍

Gaea/
├── bin/
│   ├── gaea
│   └── gaea-cli
├── config/
│   ├── config.yaml
│   └── logging.yaml
├── docs/
│   ├── README.md
│   └── CONTRIBUTING.md
├── src/
│   ├── main.go
│   ├── handlers/
│   ├── models/
│   └── utils/
├── tests/
│   ├── test_main.go
│   └── test_utils.go
├── .gitignore
├── LICENSE
└── README.md

• bin/: 存放编译后的可执行文件，包括 gaea 和 gaea-cli。
• config/: 存放项目的配置文件，如 config.yaml 和 logging.yaml。
• docs/: 存放项目的文档文件，包括 README.md 和 CONTRIBUTING.md。
• src/: 项目的源代码目录，包含主要的 Go 文件和子目录如 handlers/, models/, utils/。
• tests/: 存放项目的测试文件，如 test_main.go 和 test_utils.go。
• .gitignore: Git 忽略文件列表。
• LICENSE: 项目的开源许可证文件。
• README.md: 项目的介绍和使用说明。

2. 项目的启动文件介绍

项目的启动文件位于 src/main.go。该文件是整个项目的入口点，负责初始化配置、加载依赖、启动服务器等核心功能。

package main

import (
    "fmt"
    "gaea/config"
    "gaea/server"
)

func main() {
    // 加载配置
    config.LoadConfig()

    // 启动服务器
    server.Start()

    fmt.Println("Gaea server started successfully.")
}

3. 项目的配置文件介绍

项目的配置文件主要位于 config/ 目录下，包括 config.yaml 和 logging.yaml。

config.yaml

server:
  port: 8080
  host: "0.0.0.0"

database:
  driver: "mysql"
  connection: "user:password@tcp(localhost:3306)/dbname"

logging:
  level: "info"
  output: "stdout"

• server: 配置服务器的端口和主机地址。
• database: 配置数据库的驱动和连接信息。
• logging: 配置日志的级别和输出方式。

logging.yaml

logging:
  level: "info"
  output: "stdout"
  format: "text"

• level: 日志级别，如 info, debug, error 等。
• output: 日志输出方式，如 stdout, file 等。
• format: 日志格式，如 text, json 等。