Etym 项目启动与配置教程

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

Etym 项目的目录结构如下：

etym/
├── .gitignore         # 忽略文件列表
├── Dockerfile         # Docker构建文件
├── README.md          # 项目说明文件
├── LICENSE            # 项目许可证文件
├── bin/               # 执行文件目录
│   └── etym           # Etym主执行文件
├── cmd/               # 主应用程序目录
│   └── etym/          # Etym应用程序
│       ├── api.go      # API接口定义
│       ├── main.go     # 主函数入口
│       └── server.go   # 服务器逻辑
├── config/            # 配置文件目录
│   └── config.yaml    # 默认配置文件
├── deploy/            # 部署脚本和配置
├── docs/              # 文档目录
├── internal/          # 内部模块目录
│   ├── api/           # API处理模块
│   ├── dao/           # 数据访问对象模块
│   ├── middleware/    # 中间件模块
│   └── service/       # 服务逻辑模块
└── pkg/               # 外部依赖包目录

• .gitignore：指定Git应该忽略的文件和目录。
• Dockerfile：用于构建Docker镜像的文件。
• README.md：项目的基本信息和说明。
• LICENSE：项目的开源许可证。
• bin/：存放编译后的可执行文件。
• cmd/：存放项目的入口文件和主应用程序代码。
• config/：存放项目的配置文件。
• deploy/：存放项目部署的相关脚本和配置。
• docs/：存放项目文档。
• internal/：存放项目内部使用的模块和代码。
• pkg/：存放项目依赖的外部包。

2. 项目的启动文件介绍

项目的启动文件位于 cmd/etym/main.go。以下是启动文件的主要内容：

package main

import (
    "etym/internal/etym"
    "log"
)

func main() {
    app, err := etym.New()
    if err != nil {
        log.Fatalf("Unable to start application: %v", err)
    }
    app.Start()
}

这段代码定义了项目的主函数入口，首先创建一个 etym 应用程序实例，然后调用 Start() 方法启动应用程序。

3. 项目的配置文件介绍

项目的配置文件位于 config/config.yaml。以下是配置文件的一个示例：

server:
  port: 8080
  timeout: 30s

database:
  driver: mysql
  source: user:password@tcp(localhost:3306)/dbname?charset=utf8mb4&parseTime=True&loc=Local

log:
  level: info
  format: json

该配置文件定义了以下几个主要部分的配置：

• server：服务器配置，包括端口和超时时间。
• database：数据库配置，包括数据库驱动类型和数据库源信息。
• log：日志配置，包括日志级别和日志格式。