English | 中文
一个高性能的企业后台管理框架，使用Hertz与Ent
- 高生产率：短时间即可搭建一个企业管理系统。
- 高性能：使用Go里最强性能的 Hertz 框架。字节跳动已经在上万个服务上部署应用。
- 模块化：参考DDD设计理念，模块设计更简洁、更方便。
- 路由接口：参考 Google 开放平台，使用 Protobuf 定义接口规范。
- 面向接口开发，更好拓展与单元测试。
- 地址: https://formulago.com
- 账号: admin/formulago
- 前端项目地址: https://formulago-ui.com
看起来像F1赛车吗?
- 使用
Hertz作为 HTTP 框架 - 使用
ProtobufIDL 定义HTTP接口 - 使用
hz工具进行代码生成 - 使用
Ent与MySQL(你也可以使用PostgresSQL) - 使用
内存缓存与Redis（Config文件配置启用）
- 用户管理：用户是系统操作者，该功能主要完成系统用户配置。
- 菜单管理：配置系统菜单，操作权限，按钮权限标识等。
- 角色管理：角色菜单权限分配、设置角色的权限划分。
- 字典管理：对系统中经常使用的一些较为固定的数据进行维护。
- 操作日志：系统正常操作日志记录和查询；系统异常信息日志记录和查询。
- 在线用户：当前系统中活跃用户Token状态监控。
- 文件管理：文件上传，S3(Aliyun OSS)多种上传方式适配。
- OAuth2.0登录：支持Google, Github, Wecom 等OAuth2.0认证登录, 可以自己拓展。
- 常用工具：在pkg包集成常用的工具包。
- 开发工具：提供便捷的Struct与Protobuf转换工具，Struct to Protobuf，Delete Struct Tag等。
本项目使用Protobuf IDL 定义HTTP 接口。对应的admin模块相关接口在 admin.proto 文件中定义。
本项目使用 hz 生成代码. hz 详细使用说明参考 hz.
- hz install.
go install github.com/cloudwego/hertz/cmd/hz@latest- hz new: 新建一个 Hertz 项目
hz new -I api -idl api/admin/admin.proto -model_dir api/model -module formulago --unset_omitempty- hz update: 当你的IDL文件更新，使用该指令进行项目代码更新
- api.proto 与 base.proto是不需要更新与生成的，因为它们是由导入它们的proto文件生成的
hz update -I api -idl api/admin/admin.proto -model_dir api/model --unset_omitempty变量绑定与校验使用说明参考 Binding and Validate.
ent - 一个简单但功能强大的 Go 实体框架。
本项目使用 Ent 连接与操作 MySQL(你也可以使用PostgresSQL) ，详细使用说明参考 Ent.
- 将配置文件中数据库参数换成你自己的： Database config file.
- 在项目根目录下依次执行以下命令, 将在目录 data/ent/schema/ 生成一个User的实体:
cd data
go run -mod=mod entgo.io/ent/cmd/ent init User- 在 User schema 中添加表字段, 运行以下命令将生成Ent的操作代码文件
go generate ./ent- Ent的更多使用说明，请参考 Ent Guides.
- 使用你自己的参考更新 Prod configuration file 与 Dev configuration file。
- 注意，YAML文件的参数结构要与config.go里的Config结构体一致。
- 当运行时环境变量 "IS_PROD" 等于 true, 将会使用生产环境Prod配置, 否则使用测试环境Dev配置。
cd formulago && docker-compose upcd formulago
go build -o formulago &&./formulago
# 项目运行后，HTTP Get请求以下路由，将会初始化数据库表数据
# 初始管理员账号: admin/formulago
@router yourHost/api/initDatabase [GET]
enjoy it!