diff --git a/README.md b/README.md index f4fd4a18cd6d80410bc4ffacd82d7d5423aefbe6..b16ad3b2b327d502f726e697ca2eae707dbb1376 100644 --- a/README.md +++ b/README.md @@ -1,39 +1,111 @@ -# 干饭小团队 -#### 介绍 -{**以下是 Gitee 平台说明,您可以替换此简介** -Gitee 是 OSCHINA 推出的基于 Git 的代码托管平台(同时支持 SVN)。专为开发者提供稳定、高效、安全的云端软件开发协作平台 -无论是个人、团队、或是企业,都能够用 Gitee 实现代码托管、项目管理、协作开发。企业项目请看 [https://gitee.com/enterprises](https://gitee.com/enterprises)} -#### 软件架构 -软件架构说明 +干饭小团队 +=== +介绍 +--- +本项目是一个基于Java技术栈的后端服务系统,专注于实现高效稳定的餐饮服务管理功能。项目采用模块化设计,支持分布式部署,适用于中型业务场景的快速开发需求。 -#### 安装教程 +软件架构 +--- +技术栈: +- 核心框架:Spring Boot 2.7.x +- ORM框架:MyBatis Plus 3.5.x +- 数据库:MySQL 8.0.x + Redis 6.x +- 中间件:RabbitMQ 3.8.x +- 部署环境:Nginx 1.20.x -1. xxxx -2. xxxx -3. xxxx +模块结构: +``` +├── ganfan-admin # 管理后台模块 +├── ganfan-api # 接口服务模块 +├── ganfan-core # 核心业务模块 +├── ganfan-gateway # 网关服务 +└── ganfan-common # 公共工具类 +``` -#### 使用说明 +安装教程 +--- +1. 环境准备 + - JDK 1.8+ (推荐OpenJDK) + - Maven 3.6+ + - MySQL 8.0+ & Redis 6.0+ -1. xxxx -2. xxxx -3. xxxx +2. 数据库配置 + ```sql + CREATE DATABASE ganfan CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci; + ``` -#### 参与贡献 +3. 依赖安装(Linux/MacOS) + ```bash + # 安装Redis + sudo apt-get install redis-server -1. Fork 本仓库 -2. 新建 Feat_xxx 分支 -3. 提交代码 -4. 新建 Pull Request + # 安装RabbitMQ + sudo apt-get install rabbitmq-server + # 安装MySQL + sudo apt-get install mysql-server + ``` -#### 特技 +4. 项目构建 + ```bash + git clone https://22173.runjs.cn/test-ccannew/ganfanxiaoteam + cd ganfanxiaoteam + mvn clean package + ``` -1. 使用 Readme\_XXX.md 来支持不同的语言,例如 Readme\_en.md, Readme\_zh.md -2. Gitee 官方博客 [blog.gitee.com](https://blog.gitee.com) -3. 你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解 Gitee 上的优秀开源项目 -4. [GVP](https://gitee.com/gvp) 全称是 Gitee 最有价值开源项目,是综合评定出的优秀开源项目 -5. Gitee 官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help) -6. Gitee 封面人物是一档用来展示 Gitee 会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/) +使用说明 +--- +1. 服务启动 + ```bash + # 启动核心服务 + java -jar ganfan-core/target/ganfan-core.jar + + # 启动API网关 + java -jar ganfan-gateway/target/ganfan-gateway.jar + ``` + +2. API测试 + ```bash + curl http://localhost:8080/api/v1/restaurants + # 预期返回餐厅列表数据 + ``` + +3. 管理后台访问 + - 地址:http://localhost:8081/admin + - 默认账号:admin/123456 + +参与贡献 +--- +1. 提交PR流程 + - fork仓库 + - 创建feature分支 + - 提交代码修改 + - 描述变更内容及影响范围 + +2. 问题报告 + - 访问Gitee Issues页面 + - 提供复现步骤及日志信息 + - 标注影响版本及环境信息 + +特技 +--- +- Gitee代码片段:支持快速预览核心业务逻辑 +- 项目看板:实时展示各模块构建状态 +- 文档管理:集成Swagger API文档自动生成 +- CI/CD支持:提供Gitee Runner持续集成配置模板 +- 代码分析:内置SonarQube质量检测规则 + +项目演示 +--- +服务启动后可通过以下方式体验: +1. 访问管理后台配置餐厅信息 +2. 通过API获取推荐菜品 +3. 使用Redis缓存查看热点数据统计 +4. 通过RabbitMQ监控异步任务处理状态 + +许可证 +--- +本项目采用Apache 2.0协议,详细条款请参阅[LICENSE](LICENSE)文件。 \ No newline at end of file