调整项目架构,让框架更优化
This commit is contained in:
@@ -1,40 +1,17 @@
|
||||
# 模板文件
|
||||
# 模板
|
||||
|
||||
这个目录包含了可以直接复制到你项目中使用的模板文件。
|
||||
复制到业务项目后,按注释中的挂载点扩展即可。
|
||||
|
||||
## 包含的模板
|
||||
|
||||
- `migrate/main.go` - 数据库迁移工具模板 ⭐
|
||||
- `Dockerfile.example` - Docker 构建示例
|
||||
- `docker-compose.example.yml` - Docker Compose 示例
|
||||
- `Makefile.example` - Makefile 常用命令示例
|
||||
|
||||
## 快速使用
|
||||
|
||||
### 迁移工具模板
|
||||
| 文件 | 默认已接好 | 主要改哪里 |
|
||||
|------|------------|------------|
|
||||
| `server/main.go` | MustInit、日志、Warmup、默认中间件链、NewHandler、Close;`-config`/`-addr` | `buildOptions` / `setupMiddleware` / `registerRoutes` |
|
||||
| `migrate/main.go` | MustInit、日志、Database Warmup、Migrator、Close;`-config`/`-dir` | `buildOptions`;SQL 放 `migrations/` |
|
||||
| `Dockerfile.example` 等 | 镜像 / Compose / Makefile 示例 | 按部署环境改 |
|
||||
|
||||
```bash
|
||||
# 1. 复制到你的项目
|
||||
mkdir -p cmd/migrate
|
||||
cp templates/migrate/main.go cmd/migrate/
|
||||
|
||||
# 2. 编译
|
||||
go build -o bin/migrate cmd/migrate/main.go
|
||||
|
||||
# 3. 使用
|
||||
./bin/migrate up
|
||||
./bin/migrate -help
|
||||
mkdir -p cmd/server cmd/migrate
|
||||
cp templates/server/main.go cmd/server/main.go
|
||||
cp templates/migrate/main.go cmd/migrate/main.go
|
||||
```
|
||||
|
||||
### Docker 模板
|
||||
|
||||
```bash
|
||||
# 复制到你的项目根目录
|
||||
cp templates/Dockerfile.example Dockerfile
|
||||
cp templates/docker-compose.example.yml docker-compose.yml
|
||||
cp templates/Makefile.example Makefile
|
||||
```
|
||||
|
||||
## 完整文档
|
||||
|
||||
详细使用说明请查看:[INTEGRATION.md](../INTEGRATION.md) 第 7 节「数据库迁移」
|
||||
对接说明:[INTEGRATION.md](../INTEGRATION.md)。
|
||||
|
||||
Reference in New Issue
Block a user