Goyangi 开源项目教程

1. 项目介绍

Goyangi 是一个基于 Go 语言的 Web 应用程序开发框架。它的目标是帮助开发者快速搭建可靠的后端服务，让开发者可以将精力集中在创新和解决问题上。Goyangi 精心选择了多种轻量级包，并进行了整合，以保持简单和避免重复（DRY）的原则。

2. 项目快速启动

环境准备

• Docker
• PostgreSQL
• Yarn (用于前端依赖管理)

启动步骤

使用 Docker 启动

$ git clone https://github.com/dorajistyle/goyangi.git
$ cd goyangi
$ docker compose up -d --build

首次启动时，需要进行数据库迁移：

# 检查 'goyangi-backend' 容器的日志，确保可以连接到 Postgres
# 如果连接失败，重启 'goyangi-backend' 容器
$ docker-compose restart goyangi-backend

# 迁移数据库
$ curl http://localhost/api/v1/commands/migrate

使用 CLI 启动

$ git clone https://github.com/dorajistyle/goyangi.git
$ cd goyangi
$ go mod -U .
$ go mod tidy
# 编辑 config.yml 文件以配置数据库连接等
$ go run main.go

首次启动 CLI 模式时，同样需要进行数据库迁移：

createdb goyangi_dev -U postgres;
createdb goyangi_test -U postgres;
createdb goyangi -U postgres;
# 运行服务器后，进行迁移
$ curl http://localhost/api/v1/commands/migrate

启动前端（Vue.js）

$ cd frontend/vuejs
$ yarn
$ yarn serve

默认登录信息：

• 用户名：admin
• 密码：password

3. 应用案例和最佳实践

测试

使用 Behavior-Driven Development (BDD) 进行测试：

$ go run main.go test

API 文档

在服务器运行时，可以通过以下地址访问 API 文档：

http://localhost/swagger/index.html

前端实现

Goyangi 中的前端与后端分离，默认使用 Vue.js 作为前端框架。开发者可以轻松地添加新的前端实现，只需将代码放入 frontend/ 目录下。

4. 典型生态项目

Goyangi 使用了以下开源包和工具：

• Go 包：用于后端服务的核心逻辑。
• 前端包：包括 Vue.js 在内，用于构建动态用户界面。
• Docker：用于容器化服务和简化部署流程。
• PostgreSQL：作为数据库存储解决方案。
• Yarn：用于管理前端项目的依赖。

开发者可以根据 Goyangi 的架构和这些开源工具，创建出更多功能丰富、性能优异的 Web 应用程序。