项目名称

功能特性

软件架构(可选)

|-- CHANGELOG                   # 当前版本的更新内容或历史版本的更新记录
|-- README.md                   # 一般包含了项目的介绍、功能、快速安装和使用指引、详细的文档链接以及开发指引等
|-- ap                          # 提供当前项目对外提供的各种不同类型的API接口定义文件
|   |-- openapi
|   |-- swagger
|-- build                       # 存放安装包和持续集成相关的文件
|   |-- ci                      # 存放CI的配置文件和脚本
|   |-- docker                  # 存放子项目各个组件的Dockerfile文件
|   |-- package                 # 存放容器(Docker)、系统(deb,rpm,pkg)的包配置和脚本
|-- cmd                         # 一个项目有很多组件，存放项目组件的main函数
|-- configs                     # 存放配置文件模板或默认配置
|-- deployments                 # 存放Kubernetes部署配置和模板
|-- docs
|   |-- devel                   # 开发文档
|   |-- guid                    # 用户文档
|   |   |-- en-US               # 英文版文档
|   |   |-- zh-CN               # 中文版文档，可以根据需要组织文件结构
|   |       |-- README.md       # 用户文档入口文件
|   |       |-- api/            # API文档
|   |       |-- best-pracice    # 最佳实践，存放一些比较重要的实践文章
|   |       |-- faq             # 常见问题
|   |       |-- installation    # 安装文档
|   |       |-- introduction    # 产品介绍文档
|   |       |-- operation-guide	# 操作指南，里面可以根据RESTful资源再划分为更细的子目录
|   |       |-- quickstart      # 快速入门
|   |       |-- sdk             # SDK文档
|   |-- images                  # 图片存放目录
|   |-- man
|-- example                     # 存放应用程序或者公共包的示例代码
|-- go.mod
|-- iam.iml
|-- init                        # 初始化系统和进程管理配置文件，在非容器部署的项目中会用到
|-- internal                    # 存放私有应用和库代码
|   |-- apiserver               # 该目录中存放真实的应用代码
|   |   |-- api                 # HTTP API接口的具体实现
|   |   |   |-- v1
|   |   |-- config              # 根据命令行参数创建应用配置
|   |   |-- options             # 应用的command flag
|   |   |-- service             # 存放应用复杂业务处理代码
|   |   |-- store               # 存放与数据库交互的代码
|   |       |-- mysql
|   |-- pkg                     # 存放项目内可共享，项目外不共享的包
|       |-- cod                 # 项目业务Code码
|       |-- middleware          # HTTP处理链，中间件
|       |-- validatio           # 一些通用的验证函数
|-- pkg                         # 存放可以被外部应用使用的代码库
|   |-- app						
|   |-- cli
|   |-- component-base		
|   |-- db
|   |-- errors
|   |-- log
|   |-- shutdown
|   |-- storage
|   |-- util
|   |-- validator
|-- scripts                     # 存放脚本文件，实现构建、安装、分析等不同功能
|   |-- install
|-- test                        # 用于存放其他外部测试应用和测试数据
|-- third_party                 # 外部帮助工具，分支代码或者第三方应用（例如Swagger UI）
|-- tools                       # 存放这个项目的支持工具。这些工具可导入来自 /pkg 和 /internal 目录的代码。

快速开始

依赖检查

构建

运行

使用指南

如何贡献

社区(可选)

关于作者

谁在用(可选)

许可证