CoolAdminGo 项目教程

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

CoolAdminGo 项目的目录结构如下：

cool-admin-go/
├── devcontainer/
├── github/workflows/
├── vscode/
├── contrib/
├── cool-tools/
├── default/
├── etcd/member/
├── docs/
├── frontend/
├── i18n/
├── internal/
├── manifest/config/
├── modules/
├── scripts/
├── .gitattributes
├── .gitignore
├── LICENSE
├── Makefile
├── README.md
├── docker-compose.yml
├── go.mod
├── go.sum
├── gotidy.sh
├── gowork.sh
├── main.go
├── main_test.go
├── package.json
├── pre-release.sh
├── release.sh
└── yarn.lock

目录结构介绍

• devcontainer/: 开发容器配置文件。
• github/workflows/: GitHub Actions 工作流配置文件。
• vscode/: Visual Studio Code 配置文件。
• contrib/: 贡献代码目录。
• cool-tools/: CoolAdminGo 开发工具目录。
• default/: 默认配置目录。
• etcd/member/: etcd 成员配置目录。
• docs/: 项目文档目录。
• frontend/: 前端代码目录。
• i18n/: 国际化配置目录。
• internal/: 内部代码目录。
• manifest/config/: 配置文件目录。
• modules/: 模块代码目录。
• scripts/: 脚本文件目录。
• .gitattributes: Git 属性配置文件。
• .gitignore: Git 忽略文件配置。
• LICENSE: 项目许可证文件。
• Makefile: Makefile 文件。
• README.md: 项目介绍文件。
• docker-compose.yml: Docker Compose 配置文件。
• go.mod: Go 模块依赖文件。
• go.sum: Go 模块校验文件。
• gotidy.sh: Go 依赖清理脚本。
• gowork.sh: Go 工作环境脚本。
• main.go: 项目主入口文件。
• main_test.go: 项目测试入口文件。
• package.json: Node.js 包配置文件。
• pre-release.sh: 预发布脚本。
• release.sh: 发布脚本。
• yarn.lock: Yarn 锁定文件。

2. 项目的启动文件介绍

CoolAdminGo 项目的主入口文件是 main.go。该文件负责启动整个应用程序。以下是 main.go 文件的简要介绍：

package main

import (
    "github.com/cool-team-official/cool-admin-go/internal/app"
)

func main() {
    app.Run()
}

启动文件介绍

• main.go: 这是项目的启动文件，包含了 main 函数，负责初始化和启动应用程序。app.Run() 函数会初始化所有必要的组件并启动服务器。

3. 项目的配置文件介绍

CoolAdminGo 项目的配置文件主要位于 manifest/config/ 目录下。以下是主要的配置文件介绍：

配置文件目录结构

manifest/config/
├── config.yaml
├── database.yaml
├── server.yaml
└── ...

配置文件介绍

• config.yaml: 主配置文件，包含了应用程序的全局配置，如日志级别、环境变量等。
• database.yaml: 数据库配置文件，包含了数据库连接信息、数据库类型等。
• server.yaml: 服务器配置文件，包含了服务器的端口、IP 地址等。

配置文件示例

# config.yaml
logLevel: "info"
environment: "development"

# database.yaml
database:
  type: "mysql"
  host: "localhost"
  port: 3306
  username: "root"
  password: "password"
  name: "cool_admin"

# server.yaml
server:
  port: 8080
  address: "0.0.0.0"

以上是 CoolAdminGo 项目的目录结构、启动文件和配置文件的介绍。希望这些信息能帮助你更好地理解和使用该项目。