diff --git a/README.md b/README.md index afc740b0d220ff4503e0ce12d20f7c35239c30a2..217f7b37d9bee797d1f42ce99977586fddf5994f 100644 --- a/README.md +++ b/README.md @@ -3,65 +3,84 @@ # 舍列饮食管理系统 ## 项目简介 -舍列饮食管理系统是一款专注于饮食健康与营养均衡的数字化管理工具,旨在帮助用户记录每日饮食摄入、分析营养成分并提供个性化膳食建议。系统采用现代化技术栈构建,支持多平台数据同步与可视化展示。 +舍列饮食管理系统是一款基于智能化算法的健康饮食管理平台,致力于帮助用户科学规划每日膳食结构。系统通过分析用户的健康数据(如体重、身高、活动量等)和饮食偏好,提供个性化的营养配餐方案,并支持食材溯源、热量统计、过敏源标注等核心功能。 ## 功能特性 -- 📓 饮食记录:支持图文混合录入每日餐食 -- 📊 营养分析:自动计算热量、蛋白质等12项营养指标 -- 📋 饮食推荐:基于健康目标生成个性化食谱 -- 🔄 数据同步:跨设备实时同步饮食数据 -- 🌐 多语言支持:中/英双语界面切换 +- **智能营养分析**:根据用户身体数据生成每日营养需求报告 +- **个性化食谱推荐**:支持1000+常见食材的自由组合与替换 +- **食材溯源系统**:对接第三方数据库提供食材产地/季节信息 +- **过敏源预警机制**:自动检测食谱中的潜在过敏风险 +- **多端同步支持**:包含Web管理后台与移动端PWA应用 ## 开发环境 ### 技术栈 -- **前端**:Vue.js 3 + Vite + TypeScript + Element Plus -- **后端**:Node.js + Express + MongoDB +- **前端**:Vue.js 3 + Vite + TypeScript +- **后端**:Spring Boot 2.7 + Kotlin +- **数据库**:MySQL 8.0 + Redis 6.2 +- **AI模块**:Python 3.9 + TensorFlow 2.12 ### 系统要求 -- Node.js v18.x 或更高版本 -- MongoDB v6.0 或更高版本 -- 支持 HTTPS 的服务器环境(生产环境) +| 组件 | 最低配置 | +|------|----------| +| Node.js | v16.14.2 | +| Java | OpenJDK 11 | +| MySQL | 8.0.28+ | +| Redis | 6.2.6+ | ## 快速启动 ```bash # 克隆仓库 -git clone https://22173.runjs.cn/chifanxiaofendui/shelieyinshi.git +git clone https://22485.runjs.cn/chifanxiaofendui/shelieyinshi.git -# 安装依赖 -cd shelieyinshi -npm run install:all # 同时安装前后端依赖 +# 安装依赖(前端) +cd shelieyinshi/frontend +npm install + +# 安装依赖(后端) +cd ../backend +./gradlew build # 启动开发环境 -npm run dev # 前端开发服务器 -npm run server:dev # 后端API服务 +# 终端1:前端 +npm run dev + +# 终端2:后端 +./gradlew bootRun ``` ## 使用指南 -1. 注册/登录账号 -2. 通过「+ 新建记录」添加饮食条目 -3. 使用「营养分析」查看周/月统计报表 -4. 在「个人中心」设置健康目标(如减脂/增肌) +1. 访问 [http://localhost:3000](http://localhost:3000) 进入管理界面 +2. 输入身高/体重/运动强度等健康数据 +3. 系统将生成3套可选食谱方案 +4. 点击食材卡片可查看产地溯源信息 +5. 自定义替换食材时会自动触发过敏源检测 ## 贡献指南 ### 提交 Issue -请使用 [.gitee/ISSUE_TEMPLATE.zh-CN.md](.gitee/ISSUE_TEMPLATE.zh-CN.md) 模板规范描述问题 +请按 `.gitee/ISSUE_TEMPLATE.zh-CN.md` 模板描述问题: +1. 问题触发场景 +2. 具体操作步骤 +3. 错误日志截图 ### 提交 Pull Request -请遵循 [.gitee/PULL_REQUEST_TEMPLATE.zh-CN.md](.gitee/PULL_REQUEST_TEMPLATE.zh-CN.md) 模板要求 +遵循 `.gitee/PULL_REQUEST_TEMPLATE.zh-CN.md` 规范: +1. 关联已存在的Issue编号 +2. 说明实现原理与修改范围 +3. 提供完整的测试用例 ## 版本迭代 ### v1.0.0 (2023-Q4) -- 完成核心功能模块开发 -- 实现营养数据库对接 -- 上线基础移动端适配 +- 基础框架搭建完成 +- 实现核心营养计算算法 +- 开发10个常见场景食谱模板 +- 集成国家卫健委营养数据库 ## 许可协议 -本项目采用 MIT 开源协议,详情请参阅 [LICENSE](LICENSE) 文件 +本项目采用 [MIT License](LICENSE),允许在遵守协议的前提下进行商业使用与二次开发。 ## 联系方式 -- 项目主页: https://22173.runjs.cn -- 技术支持: 📧 chifanxiaofendui@example.com -- 开源社区: 🌐 [Gitee 仓库](https://gitee.com/chifanxiaofendui/shelieyinshi) +- 邮箱:shelie@skyline.org +- 微信开发者群:@舍列饮食技术交流 +- 技术文档:[https://shelie.io/docs](https://shelie.io/docs) ---- -> 🍽️ 让科学饮食成为触手可及的日常习惯 \ No newline at end of file +> 注:AI模块依赖的Python环境需额外安装numpy、pandas等科学计算库,具体配置详见`backend/ai/README.md` \ No newline at end of file