Ten-Minutes-App 项目教程

Ten-Minutes-App 项目教程

Ten-Minutes-App base on golang v1.12.0 + mongo-go-driver v1.x + gin v1.3.x + mongodb v4.0.6 + JSONPlaceholder, react-admin 项目地址: https://gitcode.com/gh_mirrors/te/Ten-Minutes-App

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

Ten-Minutes-App 项目的目录结构如下：

Ten-Minutes-App/
├── api/
│   ├── app/
│   ├── config/
│   ├── database/
│   ├── error/
│   ├── model/
│   ├── router/
│   └── runner/
├── test/
├── .drone.yml
├── .gitignore
├── Dockerfile.API
├── Dockerfile.UI
├── GO_VERSION
├── LICENSE
├── Makefile
├── README.md
├── Schema.png
├── app.go
├── config.yml
├── docker-compose-express-mongo.yml
├── docker-compose.API.yml
├── docker-compose.UI.yml
├── drone_ci_cd.png
├── go.mod
├── go.sum
├── test.http
├── ui-dashboard.png
└── ui-post.png

目录结构介绍

• api/: 包含项目的核心代码，包括应用逻辑、配置、数据库操作、错误处理、模型定义、路由和运行器。
  • app/: 应用逻辑代码。
  • config/: 配置文件和配置逻辑。
  • database/: 数据库操作相关代码。
  • error/: 错误处理相关代码。
  • model/: 数据模型定义。
  • router/: 路由定义。
  • runner/: 运行器代码。
• test/: 测试代码。
• .drone.yml: Drone CI/CD 配置文件。
• .gitignore: Git 忽略文件配置。
• Dockerfile.API: API 服务的 Dockerfile。
• Dockerfile.UI: UI 服务的 Dockerfile。
• GO_VERSION: Go 版本文件。
• LICENSE: 项目许可证。
• Makefile: 项目构建和运行脚本。
• README.md: 项目说明文档。
• Schema.png: 数据库模式图。
• app.go: 应用入口文件。
• config.yml: 配置文件。
• docker-compose-express-mongo.yml: Docker Compose 配置文件，用于本地搭建 MongoDB 和 Mongo Express 环境。
• docker-compose.API.yml: API 服务的 Docker Compose 配置文件。
• docker-compose.UI.yml: UI 服务的 Docker Compose 配置文件。
• drone_ci_cd.png: Drone CI/CD 流程图。
• go.mod: Go 模块定义文件。
• go.sum: Go 模块依赖校验文件。
• test.http: 测试 HTTP 请求文件。
• ui-dashboard.png: UI 仪表盘截图。
• ui-post.png: UI 文章页面截图。

2. 项目的启动文件介绍

app.go

app.go 是 Ten-Minutes-App 项目的入口文件，负责启动整个应用。以下是 app.go 的主要功能：

• 初始化配置: 加载配置文件 config.yml。
• 初始化数据库连接: 连接 MongoDB 数据库。
• 注册路由: 注册应用的所有路由。
• 启动 HTTP 服务器: 启动 Gin 框架的 HTTP 服务器，监听指定端口。

启动命令

go run app.go

3. 项目的配置文件介绍

config.yml

config.yml 是 Ten-Minutes-App 项目的配置文件，包含了应用的各种配置项。以下是 config.yml 的主要配置项：

server:
  port: 8080

database:
  url: "mongodb://localhost:27017"
  name: "ten_minutes_app"

logging:
  level: "info"

jwt:
  secret: "your_jwt_secret"

api:
  base_url: "http://localhost:8080/api"

配置项介绍

• server.port: 应用监听的端口号。
• database.url: MongoDB 数据库的连接 URL。
• database.name: 数据库名称。
• logging.level: 日志级别，如 info, debug, error 等。
• jwt.secret: JWT 密钥，用于生成和验证 JWT 令牌。
• api.base_url: API 的基础 URL。

通过这些配置项，可以灵活地调整应用的行为和环境。

Ten-Minutes-App base on golang v1.12.0 + mongo-go-driver v1.x + gin v1.3.x + mongodb v4.0.6 + JSONPlaceholder, react-admin 项目地址: https://gitcode.com/gh_mirrors/te/Ten-Minutes-App