first-update

README.md

@@ -1,2 +1,62 @@
-# YG-Datasets
+# YG-Dataset 本地启动指南
 
+## 快速启动
+
+### 1. 安装后端依赖
+
+```bash
+cd backend
+pip install -r requirements.txt
+```
+
+### 2. 启动后端
+
+```bash
+cd backend
+uvicorn app.main:app --reload --port 8000
+```
+
+后端地址: http://localhost:8000
+API 文档: http://localhost:8000/docs
+
+### 3. 安装前端依赖
+
+```bash
+cd frontend
+npm install
+```
+
+### 4. 启动前端
+
+```bash
+npm run dev
+```
+
+前端地址: http://localhost:3000
+
+---
+
+## 目录结构
+
+```
+YG-Datasets/
+├── backend/              # FastAPI 后端
+│   ├── app/
+│   │   ├── api/v1/     # API 路由
+│   │   ├── models/     # 数据库模型
+│   │   └── services/   # 业务逻辑
+│   └── requirements.txt
+├── frontend/             # Vue 3 前端
+│   ├── src/
+│   │   ├── views/     # 页面
+│   │   └── api/       # API 封装
+│   └── package.json
+└── uploads/             # 上传文件存储目录
+```
+
+## 默认配置
+
+- 数据库: SQLite (`backend/ygdataset.db`)
+- 上传目录: `backend/uploads/`
+- 后端端口: 8000
+- 前端端口: 3000