tyapi-server/docs/开始指南/快速开始指南.md

🚀 快速开始指南

前置要求

确保您的开发环境中安装了以下工具：

• Go 1.23.4+ - 编程语言环境
• Docker & Docker Compose - 容器化环境
• Git - 版本控制工具
• Make - 构建工具（可选，推荐）

一键启动

# 1. 克隆项目
git clone <your-repo-url>
cd tyapi-server-gin

# 2. 启动开发环境
make dev-up

# 3. 运行应用
make run

访问 http://localhost:8080/api/v1/health 验证启动成功。

验证安装

检查服务状态

# 检查所有容器是否正常运行
docker-compose -f docker-compose.dev.yml ps

# 检查应用健康状态
curl http://localhost:8080/api/v1/health

访问管理界面

启动成功后，您可以访问以下管理界面：

• API 文档: http://localhost:8080/swagger/
• 数据库管理: http://localhost:5050 (pgAdmin)
• 监控面板: http://localhost:3000 (Grafana)
• 链路追踪: http://localhost:16686 (Jaeger)
• 邮件测试: http://localhost:8025 (MailHog)

下一步

快速启动完成后，建议您：

1. 阅读 环境搭建指南 了解详细配置
2. 查看 开发指南 开始开发
3. 参考 API 使用指南 了解 API 用法