d73405decb
- Initialize monorepo with root workspace configuration - Set up Express.js backend with TypeScript - Set up React 18 frontend with TypeScript - Create database schema with SQLite - Implement project architecture and documentation - Add development and deployment guidelines Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
89 lines
1.8 KiB
Markdown
89 lines
1.8 KiB
Markdown
# Garmin Health Lab - 项目指南
|
||
|
||
## 项目简介
|
||
|
||
Garmin Health Lab 是一个完整的健康数据分析平台，用于：
|
||
- 获取和同步佳明（Garmin）设备数据
|
||
- 进行多维度的健康数据分析
|
||
- 提供个性化的健康建议
|
||
- 可视化健康趋势
|
||
|
||
## 技术栈
|
||
|
||
- **前端**: React 18 + TypeScript + Recharts
|
||
- **后端**: Node.js + Express + TypeScript
|
||
- **数据库**: SQLite3
|
||
- **API 集成**: Garmin Connect API
|
||
|
||
## 快速开始
|
||
|
||
### 安装
|
||
```bash
|
||
npm install
|
||
```
|
||
|
||
### 配置
|
||
```bash
|
||
cp server/.env.example server/.env
|
||
# 编辑 server/.env 填入 Garmin 凭证
|
||
```
|
||
|
||
### 开发
|
||
```bash
|
||
npm run dev
|
||
```
|
||
|
||
- 前端: http://localhost:3000
|
||
- 后端: http://localhost:5000
|
||
|
||
## 项目结构
|
||
|
||
- `client/` - React 前端应用
|
||
- `server/` - Node.js 后端服务
|
||
- `docs/` - 文档
|
||
|
||
详见 [ARCHITECTURE.md](docs/ARCHITECTURE.md) 和 [DEVELOPMENT.md](docs/DEVELOPMENT.md)
|
||
|
||
## 核心功能
|
||
|
||
1. **仪表板** - 健康数据概览和最近数据展示
|
||
2. **数据同步** - 从 Garmin 同步最新健康数据
|
||
3. **数据分析** - 趋势分析和数据可视化
|
||
4. **健康建议** - 基于数据的个性化建议
|
||
5. **设置** - 用户配置和偏好设置
|
||
|
||
## 关键特性
|
||
|
||
- ✅ Garmin API 集成
|
||
- ✅ 多维度数据分析（步数、心率、睡眠等）
|
||
- ✅ 实时数据同步
|
||
- ✅ 交互式数据可视化
|
||
- ✅ JWT 认证安全
|
||
- ✅ 本地数据存储
|
||
|
||
## 开发指南
|
||
|
||
- 详见 [DEVELOPMENT.md](docs/DEVELOPMENT.md)
|
||
- API 文档见 README.md
|
||
|
||
## 常用命令
|
||
|
||
```bash
|
||
npm run dev # 开发模式
|
||
npm run build # 构建项目
|
||
npm run typecheck # 类型检查
|
||
npm start # 生产模式
|
||
```
|
||
|
||
## 下一步任务
|
||
|
||
- [ ] 实现 Garmin OAuth 认证
|
||
- [ ] 完成 Garmin API 数据获取
|
||
- [ ] 实现仪表板可视化
|
||
- [ ] 添加数据分析算法
|
||
- [ ] 部署和优化
|
||
|
||
## 联系方式
|
||
|
||
项目维护: ericwyuan.g@gmail.com
|