README.md

Simple Admin

中文 | English

简介

Simple Admin 是一个开箱即用的分布式微服务后端管理系统，基于go-zero开发，提供丰富的功能如服务发现，权限管理等。 该框架可以帮助您快速开发具有RPC服务的后台管理系统。

特性

• 最新技术栈：使用 gorm, casbin, kafka 等前沿技术开发
• 完全支持go-swagger: 直接在api文件内编写注释即可直接生成swagger文档
• 统一的错误处理: 整个系统拥有国际化的统一错误处理
• 国际化：内置完善的国际化方案
• 服务注册发现: 完善的服务注册发现机制，原生支持K8s
• 权限: 内置完善的动态路由权限生成方案, 集成RBAC权限控制
• 其他: 流量控制， ES服务

当前进度

功能	进度
登录注册	已完成
菜单管理	已完成
角色管理	已完成
角色权限	已完成
用户管理	已完成
操作日志	已完成
服务注册发现	已完成
配置中心	已完成
字典功能	已完成
三方登录管理	已完成
全面支持 K8s	已完成
服务监控	已完成
日志收集	已完成
JWT黑名单	进行中

预览

在线预览

在线预览 账号 admin 密码 simple-admin

只读，不可修改和注册

更多预览

文档

文档

或者直接本地运行

cd docs
docsify serve .

• go-zero Document
• ant-design-vue Document

准备

• Golang and git - Go 语言
• Mysql - Mysql数据库
• GORM - GORM 数据库ORM组件
• Casbin - 权限管理
• Go-swagger - Go-swagger 文档生成调试

安装使用

• 获取项目代码

git clone https://github.com/suyuan32/simple-admin-core.git

• 安装依赖

cd simple-admin-core/

go mod tidy

• 编辑配置文件 api/etc/core.yaml rpc/etc/core.yaml
• 运行

# run core api
cd api 
go run core.go -f etc/core.yaml

# run core rpc
cd rpc
go run core.go -f etc/core.yaml

• 打包

go build -o core core.go

更新日志

CHANGELOG

项目地址

• Simple-Admin-ui
• Simple-Admin

如何贡献

非常欢迎你的加入！提一个 Issue 或者提交一个 Pull Request。

Pull Request:

1. Fork 代码!
2. 创建自己的分支: git checkout -b feat/xxxx
3. 提交你的修改: git commit -am 'feat(function): add xxxxx'
4. 推送您的分支: git push origin feat/xxxx
5. 提交pull request

Git 贡献提交规范

• 参考 vue 规范 (Angular)

  • feat 增加新功能
  • fix 修复问题/BUG
  • style 代码风格相关无影响运行结果的
  • perf 优化/性能提升
  • refactor 重构
  • revert 撤销修改
  • test 测试相关
  • docs 文档/注释
  • chore 依赖更新/脚手架配置修改等
  • workflow 工作流改进
  • ci 持续集成
  • types 类型定义文件更改
  • wip 开发中

交流群

QQ 801043319

Discord

维护者

@Ryan Su

License

MIT © Ryan-2022