Create Go App CLI 使用教程

Create Go App CLI 使用教程

cli✨ A complete and self-contained solution for developers of any qualification to create a production-ready project with backend (Go), frontend (JavaScript, TypeScript) and deploy automation (Ansible, Docker) by running only one CLI command.项目地址:https://gitcode.com/gh_mirrors/cli11/cli

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

Create Go App CLI 是一个用于快速创建 Go 应用程序的命令行工具。以下是该项目的目录结构及其介绍：

create-go-app/
├── .github/
│   └── workflows/
│       └── ci.yml
├── assets/
│   ├── docker/
│   │   ├── backend/
│   │   └── frontend/
│   └── scripts/
│       ├── backend/
│       └── frontend/
├── cmd/
│   └── cgapp/
│       └── main.go
├── internal/
│   ├── pkg/
│   │   ├── backend/
│   │   ├── frontend/
│   │   └── tpl/
│   └── utils/
├── templates/
│   ├── backend/
│   │   ├── app/
│   │   ├── config/
│   │   ├── Dockerfile
│   │   ├── go.mod
│   │   ├── go.sum
│   │   ├── Makefile
│   │   └── README.md
│   └── frontend/
│       ├── public/
│       ├── src/
│       ├── Dockerfile
│       ├── package.json
│       ├── README.md
│       └── yarn.lock
├── .gitignore
├── LICENSE
├── README.md
└── go.mod

目录结构介绍

• .github/workflows/: GitHub Actions 的工作流配置文件。
• assets/: 包含 Docker 和脚本文件，用于后端和前端的配置。
• cmd/cgapp/: 项目的入口文件 main.go 所在目录。
• internal/: 包含项目的内部包和工具函数。
• templates/: 包含后端和前端的模板文件，用于生成项目结构。
• .gitignore: Git 忽略文件配置。
• LICENSE: 项目许可证。
• README.md: 项目说明文档。
• go.mod: Go 模块文件。

2. 项目的启动文件介绍

项目的启动文件位于 cmd/cgapp/main.go。该文件是整个应用程序的入口点，负责初始化和启动 CLI 工具。

package main

import (
	"github.com/create-go-app/cli/internal/pkg/cgapp"
)

func main() {
	cgapp.Execute()
}

启动文件介绍

• main.go: 主函数 main 调用 cgapp.Execute() 方法，该方法负责解析命令行参数并执行相应的命令。

3. 项目的配置文件介绍

项目的配置文件主要位于 templates/ 目录下，包含后端和前端的模板文件。以下是一些关键配置文件的介绍：

后端配置文件

• templates/backend/Dockerfile: 后端的 Docker 配置文件。
• templates/backend/go.mod: Go 模块文件，定义项目依赖。
• templates/backend/Makefile: 包含构建和运行项目的命令。
• templates/backend/README.md: 后端项目的说明文档。

前端配置文件

• templates/frontend/Dockerfile: 前端的 Docker 配置文件。
• templates/frontend/package.json: 前端项目的依赖管理文件。
• templates/frontend/README.md: 前端项目的说明文档。

其他配置文件

• .gitignore: 定义 Git 忽略的文件和目录。
• LICENSE: 项目许可证。
• README.md: 项目总体说明文档。
• go.mod: Go 模块文件，定义项目依赖。

通过这些配置文件，可以快速搭建和运行一个 Go 应用程序，并进行相应的配置和管理。

cli✨ A complete and self-contained solution for developers of any qualification to create a production-ready project with backend (Go), frontend (JavaScript, TypeScript) and deploy automation (Ansible, Docker) by running only one CLI command.项目地址:https://gitcode.com/gh_mirrors/cli11/cli