go-platform/docs/README.md
2026-04-09 16:26:38 +08:00

64 lines
2.0 KiB
Markdown

# Go后端项目文档
## 📚 文档目录
### 开发文档
- [后端开发规则](./后端开发规则.md)
- [接口文件](./接口文件.md)
- [服务端启动命令](./服务端启动命令.md)
### 存储配置功能文档
- [📖 快速开始](./QUICK_START.md) - 5分钟快速上手
- [📘 完整实现说明](./README_STORAGE.md) - 功能概述和使用指南
- [📗 详细使用指南](./storage-config-guide.md) - 深入的配置和使用说明
- [✅ 部署检查清单](./DEPLOYMENT_CHECKLIST.md) - 生产环境部署指南
- [🎉 实现报告](./IMPLEMENTATION_COMPLETE.md) - 完整的实现细节
### 数据库文档
- [SQL迁移脚本](./sql/) - 数据库迁移文件
## 🚀 快速导航
### 新手入门
1. 阅读 [快速开始](./QUICK_START.md)
2. 查看 [服务端启动命令](./服务端启动命令.md)
3. 了解 [后端开发规则](./后端开发规则.md)
### 存储功能使用
1. [快速开始](./QUICK_START.md) - 快速配置存储
2. [完整实现说明](./README_STORAGE.md) - 了解核心功能
3. [详细使用指南](./storage-config-guide.md) - 深入学习
### 生产部署
1. [部署检查清单](./DEPLOYMENT_CHECKLIST.md) - 按清单逐项检查
2. [实现报告](./IMPLEMENTATION_COMPLETE.md) - 了解技术细节
## 📂 项目结构
```
go/
├── controllers/ # 控制器层
├── models/ # 数据模型层
├── services/ # 业务服务层
├── routers/ # 路由配置
├── pkg/ # 公共包
├── conf/ # 配置文件
├── migrations/ # 数据库迁移
├── scripts/ # 脚本工具
└── docs/ # 文档(本目录)
```
## 🔗 相关链接
- [Beego框架文档](https://beego.vip/)
- [七牛云开发文档](https://developer.qiniu.com/)
- [Go语言官方文档](https://golang.org/doc/)
## 📝 更新日志
### 2024-01-01
- ✅ 完成存储配置功能
- ✅ 支持本地存储和七牛云存储
- ✅ 实现文件迁移功能
- ✅ 完善文档体系