From 73c9b131ed18ef036d753ab7bda3c80692fe646b Mon Sep 17 00:00:00 2001 From: gitee-bot Date: Wed, 8 Apr 2026 06:20:50 +0000 Subject: [PATCH] Update README.md --- README.md | 94 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 94 insertions(+) diff --git a/README.md b/README.md index e69de29..29b6001 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,94 @@ + + +# 估骨通 (Gujiantong) + +一款骨骼健康管理与知识分享的全栈应用系统,提供骨骼信息查询、健康保养知识学习、用户交流反馈等功能。 + +## 项目简介 + +估骨通是一个面向骨骼健康领域的综合性平台,后端采用 Spring Boot 框架开发,前端分为移动端(UniApp)和管理后台(Vue 3)两部分。系统主要包括骨骼信息管理、保养知识库、用户反馈、社区论坛等功能模块。 + +## 技术架构 + +### 后端 +- **框架**:Spring Boot +- **数据库**:MySQL +- **模板引擎**:Beetl +- **安全**:Spring Security + +### 移动端 (UniApp) +- **框架**:UniApp (Vue.js) +- **特点**:跨平台运行,支持 H5、小程序 + +### 管理后台 +- **框架**:Vue 3 + TypeScript + Vite +- **UI 组件**:自定义 CRUD 组件 +- **富文本编辑**:TinyMCE + +## 功能模块 + +| 模块 | 说明 | +|------|------| +| 骨骼信息 | 骨骼部位、位置关键点查询 | +| 保养知识 | 健康知识文章浏览与管理 | +| 意见反馈 | 用户反馈提交与处理 | +| 用户中心 | 个人收藏、帖子、评论管理 | +| 论坛社区 | 发帖、评论交流 | + +## 快速开始 + +### 后端启动 + +```bash +cd backend +# 配置数据库连接 (application.yml) +mvn spring-boot:run +``` + +服务默认运行在 `http://localhost:8080` + +### 前端启动 + +**移动端:** +```bash +cd uniapp +npm install +npm run dev +``` + +**管理后台:** +```bash +cd web +npm install +npm run dev +``` + +管理后台默认运行在 `http://localhost:5173` + +## 项目结构 + +``` +├── backend/ # Java 后端服务 +│ └── src/main/java/com/gujiantong/ +│ ├── controller/ # 控制器 +│ ├── entity/ # 数据实体 +│ ├── service/ # 业务服务 +│ └── config/ # 配置类 +├── uniapp/ # UniApp 移动端 +│ └── src/pages/ # 页面组件 +└── web/ # Vue 3 管理后台 + └── src/ # 前端源码 +``` + +## API 接口 + +| 接口路径 | 说明 | +|---------|------| +| `/api/v1/bone` | 骨骼信息管理 | +| `/api/v1/bone/by-position` | 按位置获取骨骼 | +| `/api/v1/health` | 保养知识管理 | +| `/api/v1/feedback` | 意见反馈管理 | + +## 许可证 + +MIT License \ No newline at end of file -- Gitee