From 01417eb3d782ab23e8fa70e7b5b346772063358a Mon Sep 17 00:00:00 2001 From: odboy Date: Wed, 11 Dec 2024 20:52:15 +0800 Subject: [PATCH] Signed-off-by: odboy --- .gitee/ISSUE_TEMPLATE.zh-CN.md | 13 ------- .gitee/PULL_REQUEST_TEMPLATE.zh-CN.md | 53 -------------------------- .idea/.gitignore | 8 ---- README.md | 55 +++++++++++++++------------ {sql => docs}/d2admin.sql | 0 web/.env.daily | 2 +- 6 files changed, 32 insertions(+), 99 deletions(-) delete mode 100644 .gitee/ISSUE_TEMPLATE.zh-CN.md delete mode 100644 .gitee/PULL_REQUEST_TEMPLATE.zh-CN.md delete mode 100644 .idea/.gitignore rename {sql => docs}/d2admin.sql (100%) diff --git a/.gitee/ISSUE_TEMPLATE.zh-CN.md b/.gitee/ISSUE_TEMPLATE.zh-CN.md deleted file mode 100644 index f09d98d..0000000 --- a/.gitee/ISSUE_TEMPLATE.zh-CN.md +++ /dev/null @@ -1,13 +0,0 @@ -### 该问题是怎么引起的？ - - - -### 重现步骤 - - - -### 报错信息 - - - - diff --git a/.gitee/PULL_REQUEST_TEMPLATE.zh-CN.md b/.gitee/PULL_REQUEST_TEMPLATE.zh-CN.md deleted file mode 100644 index 0ed1c31..0000000 --- a/.gitee/PULL_REQUEST_TEMPLATE.zh-CN.md +++ /dev/null @@ -1,53 +0,0 @@ -### 一、内容说明（相关的Issue） - - - -### 二、建议测试周期和提测地址 - 建议测试完成时间：xxxx.xx.xx - 投产上线时间：xxxx.xx.xx - 提测地址：CI环境/压测环境 - 测试账号： - -### 三、变更内容 - * 3.1 关联PR列表 - - * 3.2 数据库和部署说明 - 1. 常规更新 - 2. 重启unicorn - 3. 重启sidekiq - 4. 迁移任务：是否有迁移任务，没有写 "无" - 5. rake脚本：`bundle exec xxx RAILS_ENV = production`；没有写 "无" - - * 3.4 其他技术优化内容（做了什么，变更了什么） - - 重构了 xxxx 代码 - - xxxx 算法优化 - - - * 3.5 废弃通知（什么字段、方法弃用？） - - - - * 3.6 后向不兼容变更（是否有无法向后兼容的变更？） - - - -### 四、研发自测点（自测哪些？冒烟用例全部自测？） - 自测测试结论： - - -### 五、测试关注点（需要提醒QA重点关注的、可能会忽略的地方） - 检查点： - -| 需求名称 | 是否影响xx公共模块 | 是否需要xx功能 | 需求升级是否依赖其他子产品 | -|------|------------|----------|---------------| -| xxx | 否 | 需要 | 不需要 | -| | | | | - - 接口测试： - - 性能测试： - - 并发测试： - - 其他： - diff --git a/.idea/.gitignore b/.idea/.gitignore deleted file mode 100644 index 13566b8..0000000 --- a/.idea/.gitignore +++ /dev/null @@ -1,8 +0,0 @@ -# Default ignored files -/shelf/ -/workspace.xml -# Editor-based HTTP Client requests -/httpRequests/ -# Datasource local storage ignored files -/dataSources/ -/dataSources.local.xml diff --git a/README.md b/README.md index 86aaf5a..489742c 100644 --- a/README.md +++ b/README.md @@ -1,43 +1,50 @@ # d2admin-service -#### 项目说明 +## 项目说明 -```text -前端：https://gitee.com/d2-projects/d2-admin-start-kit +本项目为一个前后端分离的应用，旨在提供一个简洁、易学的后端服务框架。 -后端：从零开始。无依赖Casbin，无二次封装，适合学习。 -``` +- **前端**: [D2 Admin Start Kit](https://gitee.com/d2-projects/d2-admin-start-kit) +- **后端**: 从零开始构建，无依赖Casbin，无二次封装，适合学习。 -### 文档地址 +## 文档地址 -```text -# gin -https://gin-gonic.com/docs/quickstart -# gorm -https://gorm.io/zh_CN/docs/index.html -``` +- **Gin 框架**: [官方文档](https://gin-gonic.com/docs/quickstart) +- **GORM 框架**: [官方文档](https://gorm.io/zh_CN/docs/index.html) -### 结构说明 -```text -1、所有API接口必须在"src/infra/bind_api.go"上定义与"gin.HandlerFunc"的绑定关系 -2、所有API接口必须在"system_api"表中定义 -``` +## 项目结构 -### golang版本 +- **API 接口**: + - 所有 API 接口必须在 `src/infra/bind_api.go` 文件中定义，并与 `gin.HandlerFunc` 绑定。 + - 所有 API 接口必须在数据库表 `system_api` 中定义。 -```text -go1.21.5 darwin/amd64 -``` +## Go 版本 -### 安装依赖并启动 +- **版本**: go1.21.5 darwin/amd64 + +## 安装依赖并启动 ```bash go mod tidy go run main.go ``` -### 构建 +## 构建 ```bash go build -o d2admin-service -``` \ No newline at end of file +``` + +## 贡献指南 + +欢迎贡献代码！请遵循以下步骤： + +1. **Fork 仓库** +2. **创建新分支**: `git checkout -b feature/your-feature` +3. **提交更改**: `git commit -m 'Add some feature'` +4. **推送分支**: `git push origin feature/your-feature` +5. **发起 Pull Request** + +## 许可证 + +本项目采用 [MIT License](LICENSE) 许可证。 diff --git a/sql/d2admin.sql b/docs/d2admin.sql similarity index 100% rename from sql/d2admin.sql rename to docs/d2admin.sql diff --git a/web/.env.daily b/web/.env.daily index bbc58da..217ae2f 100644 --- a/web/.env.daily +++ b/web/.env.daily @@ -1,7 +1,7 @@ # 日常环境 # 指定构建模式 -NODE_ENV=production +NODE_ENV=development # 页面 title 前缀 VUE_APP_TITLE=D2Admin