慕旋后台管理模板
项目介绍
慕旋后台管理模板是一套完整的后台管理系统解决方案,前端采用 Vue3 + Vite 技术栈,后端采用 Golang + Gin + GORM 框架,数据存储使用 MySQL 和 Redis。
技术栈
- 前端: Vue3 + Vite
- UI 组件: 待确定
- 后端: Golang + Gin
- 数据库: MySQL + GORM
- 缓存: Redis
Git 仓库
前端项目:
git clone https://git.2p2.cn/bug_busters/mx-base-admin-vue3.git
后端项目:
git clone https://git.2p2.cn/bug_busters/mx-base-admin-go.git
开发规范
本文档详细说明了项目的开发规范、Git提交规范、分支管理策略以及各环境的配置信息。
Git 提交规范
提交信息格式
所有提交信息必须遵循以下格式:
<type>(<scope>): <subject>
Type(类型)
feat: 新功能fix: 修复bugdocs: 文档更新style: 代码格式调整(不影响代码逻辑)refactor: 代码重构test: 测试相关chore: 构建过程或辅助工具的变动
Scope(范围)
- 说明提交影响的范围,如:
user、order、auth等
提交示例
feat(user): 添加用户注册功能
分支管理策略
分支类型
1. 主分支(master)
- 用途: 生产环境代码
- 保护: 禁止直接推送,必须通过Merge Request
- 合并: 只能从特性分支合并
2. 测试分支(sit)
- 用途: 测试环境代码
- 保护: 禁止直接推送,必须通过Merge Request
- 合并: 接收特性分支的合并请求
3. 特性分支(feature/*)
- 命名:
feat/账号名-功能名称-日期,如:feat/LuaoX-createUser-20260331 - 来源: 从master分支创建
- 目标: 合并到sit或master分支
开发流程
1. 创建特性分支
# 从master分支创建新特性分支
git switch master
git pull origin master
git switch -c feat/账号名-功能名称-$(date +%Y%m%d)
2. 提交代码到特性分支
# 在特性分支上开发并提交
git add .
git commit -m "feat(scope): 功能描述"
git push -u origin feat/账号名-功能名称-$(date +%Y%m%d)
3. 提交Merge Request到sit分支
- 在代码管理平台创建Merge Request
- 源分支:特性分支
- 目标分支:sit分支
- 添加相关Reviewers
4. 处理冲突
sit分支冲突处理:
# 将sit分支合并到特性分支解决冲突
git switch sit
git pull
git merge feat/账号名-功能名称-$(date +%Y%m%d)
# 解决冲突后提交
git add .
git commit -m "fix: 解决合并冲突"
git push
master分支冲突处理:
# 将master分支合并到特性分支解决冲突
git switch master
git pull
git switch feat/账号名-功能名称-$(date +%Y%m%d)
git merge master
# 解决冲突后提交
git add .
git commit -m "fix: 解决与master分支的冲突"
git push feat/账号名-功能名称-$(date +%Y%m%d)
环境配置
测试环境(SIT)
前端服务
- 地址: http://127.0.0.1
- 端口: 5173
后端服务
- 地址: https://api-sit.2p2.cn
- 数据库: MySQL 5.7
- 缓存: Redis 8.0.5
数据库配置
- 地址: 159.75.47.58
- 数据库名: mx_db2
- 用户名: mx_db2
- 密码: luoaoxuan0818
生产环境(Master)
暂无
代码审查规范
审查要点
- 功能完整性: 代码是否实现需求功能
- 代码质量: 是否符合编码规范
- 测试覆盖: 是否有相应的单元测试
- 安全性: 是否存在安全漏洞
- 性能: 是否存在性能问题
审查流程
- 创建Merge Request
- 指定至少1名Reviewer
- Reviewer在24小时内完成审查
- 根据反馈修改代码
- 审查通过后合并
部署流程
测试环境部署
- 特性分支合并到sit分支
- 自动触发CI/CD流水线
- 运行自动化测试
- 部署到测试环境
- 进行功能测试
生产环境部署
- 特性分支合并到master分支
- 自动触发生产环境部署流水线
- 运行完整测试套件
- 部署到生产环境
- 监控系统运行状态
注意事项
- 禁止直接推送到sit和master分支
- 每次提交必须包含有意义的提交信息
- 特性分支命名要清晰易懂
- 冲突解决要谨慎,确保不丢失代码
- 数据库变更需要同步更新后台代码
- 配置文件中敏感信息要使用环境变量
最后更新: 2026-03-31