一键生成生产级 Go 应用:Create Go App CLI (cgapp) 使用手册

Create Go App CLI(简称 cgapp)是一个强大的命令行工具,旨在帮助开发者快速生成生产级的 Go 应用程序。通过 cgapp,你可以轻松创建包含前端、后端以及数据库集成的完整项目结构,极大地简化了项目的初始化过程。

安装

首先,你需要确保已经安装了 Go 环境。然后,你可以通过以下命令安装 cgapp

go install github.com/create-go-app/cli/v4/cmd/cgapp@latest

现在macOS系统还支持brew安装

# Tap a new formula:
brew tap create-go-app/tap

# Installation:
brew install create-go-app/tap/cgapp

基本使用

1. 创建新项目

使用 cgapp 创建一个新项目非常简单。建一个空目录,然后进入目录,运行以下命令:

cgapp create

在运行过程中,cgapp 会提示你选择项目模板、前端框架、后端框架以及数据库类型。你可以根据自己的需求进行选择。

demo.gif

2. 项目结构

cgapp 生成的项目结构通常如下:

myapp/
├── backend/
│   ├── cmd/
│   ├── internal/
│   ├── pkg/
│   ├── go.mod
│   └── go.sum
├── frontend/
│   ├── public/
│   ├── src/
│   ├── package.json
│   └── ...
├── docker-compose.yml
├── .env
└── README.md
  • backend/:包含 Go 后端代码。
  • frontend/:包含前端代码(如 React、Vue 等)。
  • docker-compose.yml:用于启动项目所需的 Docker 容器。
  • .env:环境变量配置文件。

3. 启动项目

在后台目录下,运行以下命令启动项目:

go run main.go

当然也可以直接在根目录下用docker折腾

docker-compose up

这将启动后端服务、前端服务以及数据库服务(如果配置了数据库)。

4. 项目部署

cgapp deploy [OPTION]

deploy.gif


高级功能

1. 自定义模板

cgapp 支持自定义项目模板。你可以通过以下命令创建一个自定义模板:

cgapp template create my-template

然后,你可以编辑 my-template 目录中的文件,以满足你的特定需求。

2. 插件系统

cgapp 还支持插件系统,允许你在项目创建过程中添加额外的功能。例如,你可以添加一个插件来集成 Swagger API 文档:

cgapp plugin add swagger

3. 环境变量管理

cgapp 生成的项目包含一个 .env 文件,用于管理环境变量。你可以通过编辑该文件来配置数据库连接、API 密钥等。

技术要点

1. Go 模块管理

cgapp 生成的项目使用 Go 模块进行依赖管理。你可以在 backend/go.mod 文件中添加或更新依赖。

2. Docker 集成

cgapp 通过 docker-compose.yml 文件集成 Docker,使得项目可以在任何环境中轻松部署。

3. 前端框架选择

cgapp 支持多种前端框架,如 React、Vue、Angular 等。你可以根据项目需求选择合适的前端框架。

涉及的难点

1. 模板定制

虽然 cgapp 提供了丰富的模板选择,但在某些情况下,你可能需要定制模板以满足特定需求。这需要你对 Go 模板引擎有一定的了解。

2. 插件开发

如果你需要开发自定义插件,你需要熟悉 cgapp 的插件系统架构,并能够编写符合规范的插件代码。

3. 环境配置

在多环境(开发、测试、生产)中,环境变量的管理可能会变得复杂。你需要确保 .env 文件中的配置在不同环境中都能正确加载。

项目开源地址: https://github.com/create-go-app/cli

标签: Go

相关文章

从入门到放弃:使用 spf13/viper 管理 Go 应用配置

在现代软件开发中,配置管理是一个至关重要的环节。随着应用的复杂性增加,配置管理的需求也变得更加多样化和复杂化。Go 语言社区中,spf13/viper 是一个非常流行的配置管理库,它提供了一种强...

使用 spf13/cobra 构建强大的 Go 命令行应用

spf13/cobra 是 Go 语言中非常流行的一个库,用于创建命令行应用(CLI)。它提供了一种强大且易于使用的框架来开发支持复杂命令结构的应用程序。Cobra 库主要用于创建像 kubec...

Go语言Web框架 Fiber入门教程

Fiber 是一个基于 Go 语言的 Web 框架,灵感来源于 Express.js,旨在提供快速、简单且轻量级的开发体验。Fiber 的设计目标是让开发者能够快速构建高性能的 Web 应用,同...

Go语言跨平台GUI工具包tk9.0

不得不说,这名字起的.....tk9.0是一个用Go语言编写的跨平台GUI工具包,它使用Tcl/Tk作为底层图形库,无需CGo,这意味着您可以使用它来创建原生跨平台应用程序,而无需依赖于C语言编...

基于Go语言开源免费轻量级网站防火墙SamWaf

SamWaf网站防火墙是一款适用于小公司、工作室和个人网站的免费轻量级网站防火墙,完全私有化部署,数据加密且仅保存本地,一键启动,支持Linux,Windows 64位主要功能:完全独立引擎,防...

如何实现让我们部署的Go应用在进程挂掉之后自动重启

在软件开发和部署过程中,确保应用的高可用性是至关重要的。对于使用Go语言开发的应用来说,实现在进程异常终止后自动重启是提高服务稳定性的有效策略之一。下面将围绕如何实现Go应用在挂掉之后自动重启进...

图片Base64编码

CSR生成

图片无损放大

图片占位符

Excel拆分文件