开箱即用的 GoWind Admin|风行,企业级前后端一体中后台框架:后端项目结构说明
开箱即用的 GoWind Admin|风行,企业级前后端一体中后台框架:后端项目结构说明
.docker:存放 Docker 相关配置文件api:存放 API 相关代码,API 使用 Protobuf 定义,使用 Buf 进行编译管理。gen:存放 API 服务生成的代码,目前只有 Go 语言的代码;protos:存放 API 服务的 Protobuf 的 proto 文件,它的目录结构是{服务名}/service/{版本号}。buf.gen.yaml:buf 配置文件,用于生成 API 服务的 Go 代码。buf.admin.openapi.gen.yamlbuf 配置文件,用于生成 Admin 服务的 OpenAPI 文档。buf.admin.typescript.gen.yamlbuf 配置文件,用于生成 Admin 服务的 TypeScript 代码。buf.yamlbuf 配置文件。app:存放应用服务相关代码,它的目录结构是{服务名/service},目前只有 Admin 服务。admin/service:存放 Admin 服务相关代码Makefile:Makefile 文件,调用项目根目录下的app.mk,用于构建、运行、测试 Admin 服务。cmd:存放 Admin 服务的命令行代码server:存放 Admin 服务的入口代码assets:存放 Admin 服务的静态资源文件,现在只存放了 OpenAPI 的静态资源文件。configs:存放 Admin 服务的配置文件internal:存放 Admin 服务的内部代码,使用 internal 目录是为了避免被外部代码引用。data:存放 Admin 服务的数据访问代码ent:存放 Admin 服务的 数据库 Ent ORM 代码gorm:存放 Admin 服务的 数据库 GORM ORM 代码server:存放 Admin 服务的服务端代码service:存放 Admin 服务的服务代码pkg:存放通用代码script:存放 Shell 脚本代码,用于项目的构建、部署等,如果系统新装,需要执行prepare_{OS}.sh脚本,安装依赖软件;以及install_docker_dependences.sh安装第三方 Docker 中间件的容器;平时就使用build_install.sh安装项目的服务,使用 PM2 进行进程管理。sql:存放 SQL 文件,里面存放了数据库的初始化 SQL 文件,以及一些测试数据的 SQL 文件。app.mk:存放应用服务使用的 Makefile 文件,它由app/{服务名}/service下的Makefile调用,用于构建、运行、测试应用服务。Makefile:项目根目录下的 Makefile 文件,可以用来安装 cli,生成 api 代码等。README.md:项目后端的说明文档。
项目代码
版权声明: 本文为 InfoQ 作者【喵个咪】的原创文章。
原文链接:【http://xie.infoq.cn/article/8e4c471c908185ea5fc27901f】。文章转载请联系作者。







评论