diff --git a/README.md b/README.md index c2dda79..e8f8fa8 100644 --- a/README.md +++ b/README.md @@ -53,3 +53,50 @@ make proto-clean make build ``` + +# 目录结构 + +``` +├── api +│ └── v1 +├── cmd +│ ├── main.go +├── config +│ ├── config.go +│ └── config.yaml +├── deploy +│ └── docker +├── go.mod +├── go.sum +├── internal +│ ├── models +│ ├── scope +│ ├── service +├── Makefile +├── README.md +├── third_party +│ ├── aeus +│ ├── errors +│ ├── google +│ ├── openapi +│ ├── README.md +│ └── validate +├── vendor +├── version +│ └── version.go +├── web +└── webhook.yaml +``` + +| 目录 | 描述 | +| --- | --- | +| api | api定义目录 | +| cmd | 启动命令目录 | +| config | 配置目录 | +| deploy | 部署目录 | +| internal | 内部文件目录 | +| internal.service | 服务定义目录 | +| internal.models | 模型定义目录 | +| internal.scope | 服务scope定义目录,主要有全局的变量(比如DB,Redis等) | +| third_party | 第三方proto文件目录 | +| web | 前端资源目录 | \ No newline at end of file