151 lines
4.0 KiB
Markdown
151 lines
4.0 KiB
Markdown
|
# Exhibition Demo 项目 Data 文件夹结构规范
|
|||
|
|
|
|||
|
|
## 概述
|
|||
|
|
exhibition-demo 项目中存在两个 `data` 文件夹，各自有明确的用途和归档规范。
|
|||
|
|
|
|||
|
|
## 📁 src/data/ - 应用程序逻辑数据
|
|||
|
|
|
|||
|
|
### 用途
|
|||
|
|
存放前端应用的**配置数据和业务逻辑代码**
|
|||
|
|
|
|||
|
|
### 内容结构
|
|||
|
|
```
|
|||
|
|
src/data/
|
|||
|
|
├── terminalSimulations/ # 终端模拟逻辑（TypeScript）
|
|||
|
|
│ ├── food.ts # 食品订单班模拟
|
|||
|
|
│ ├── wenlu.ts # 文旅订单班模拟
|
|||
|
|
│ └── ... # 其他订单班模拟
|
|||
|
|
├── agents/ # Agent 配置逻辑
|
|||
|
|
└── orderClasses.json # 订单班分类配置
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
### 特点
|
|||
|
|
- 文件类型：TypeScript (.ts) / JavaScript (.js) / JSON (.json)
|
|||
|
|
- 处理方式：会被 Vite 打包到应用中
|
|||
|
|
- 访问方式：通过 import 导入到代码中使用
|
|||
|
|
|
|||
|
|
### 适合存放的内容
|
|||
|
|
✅ TypeScript 配置文件
|
|||
|
|
✅ JavaScript 逻辑代码
|
|||
|
|
✅ JSON 配置数据
|
|||
|
|
✅ Agent 业务逻辑
|
|||
|
|
✅ 模拟数据生成代码
|
|||
|
|
|
|||
|
|
### 不适合存放的内容
|
|||
|
|
❌ 图片文件
|
|||
|
|
❌ 文档文件
|
|||
|
|
❌ 静态资源
|
|||
|
|
❌ 头像图片
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
## 📁 public/data/ - 静态资源文件
|
|||
|
|
|
|||
|
|
### 用途
|
|||
|
|
存放**静态资源文件**，通过 URL 直接访问
|
|||
|
|
|
|||
|
|
### 内容结构
|
|||
|
|
```
|
|||
|
|
public/data/
|
|||
|
|
├── Agent_prompt/ # Agent 提示词文档
|
|||
|
|
├── agent头像/ # Agent 头像图片
|
|||
|
|
├── 会展策划/ # 会展相关资源
|
|||
|
|
└── 订单班文档资料/ # 软链接 -> 项目根目录/data/订单班文档资料
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
### 特点
|
|||
|
|
- 文件类型：图片 (.jpg/.png/.svg) / 文档 / 其他静态文件
|
|||
|
|
- 处理方式：不会被打包，直接复制到构建输出目录
|
|||
|
|
- 访问方式：通过 `/data/...` URL 路径在浏览器中访问
|
|||
|
|
|
|||
|
|
### 软链接说明
|
|||
|
|
`public/data/订单班文档资料` 是一个符号链接，指向：
|
|||
|
|
```
|
|||
|
|
/Users/xiaoqi/Documents/Dev/Project/2025-09-08_n8nDEMO演示/data/订单班文档资料
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
**重要**: 此软链接已经创建，不需要重复创建。Vite 配置中已添加 `fs.allow: ['..']` 允许访问。
|
|||
|
|
|
|||
|
|
### 适合存放的内容
|
|||
|
|
✅ 图片文件（.jpg, .png, .svg, .webp）
|
|||
|
|
✅ Agent 头像
|
|||
|
|
✅ 文档资料
|
|||
|
|
✅ Markdown 文件
|
|||
|
|
✅ 其他静态资源
|
|||
|
|
|
|||
|
|
### 不适合存放的内容
|
|||
|
|
❌ TypeScript 代码
|
|||
|
|
❌ JavaScript 逻辑
|
|||
|
|
❌ JSON 配置（应放在 src/data/）
|
|||
|
|
❌ 需要被打包的代码
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
## 🎯 快速判断规则
|
|||
|
|
|
|||
|
|
### 问自己：
|
|||
|
|
1. **这是代码吗？** → 放 `src/data/`
|
|||
|
|
2. **这是资源吗？** → 放 `public/data/`
|
|||
|
|
|
|||
|
|
### 示例判断
|
|||
|
|
|
|||
|
|
| 文件类型 | 存放位置 | 原因 |
|
|||
|
|
|---------|---------|------|
|
|||
|
|
| food.ts | src/data/terminalSimulations/ | 业务逻辑代码 |
|
|||
|
|
| orderClasses.json | src/data/ | 配置数据 |
|
|||
|
|
| 餐饮市场调研专家.jpeg | public/data/agent头像/ | 静态图片资源 |
|
|||
|
|
| Agent提示词.md | public/data/Agent_prompt/ | 文档资源 |
|
|||
|
|
| 店面图片_正门.jpg | public/data/订单班文档资料/食品/... | 文档配图 |
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
## 🔧 Vite 配置要求
|
|||
|
|
|
|||
|
|
为了让 public/data/ 中的软链接正常工作，vite.config.ts 必须包含：
|
|||
|
|
|
|||
|
|
```typescript
|
|||
|
|
export default defineConfig({
|
|||
|
|
server: {
|
|||
|
|
fs: {
|
|||
|
|
allow: ['..'], // 允许访问父目录
|
|||
|
|
},
|
|||
|
|
},
|
|||
|
|
preview: {
|
|||
|
|
fs: {
|
|||
|
|
allow: ['..'],
|
|||
|
|
},
|
|||
|
|
},
|
|||
|
|
})
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
## ⚠️ 违规提醒清单
|
|||
|
|
|
|||
|
|
如果发现以下情况，需要提醒用户：
|
|||
|
|
|
|||
|
|
### src/data/ 违规情况
|
|||
|
|
- [ ] 存放了图片文件（应移到 public/data/）
|
|||
|
|
- [ ] 存放了文档文件（应移到 public/data/）
|
|||
|
|
- [ ] 存放了头像文件（应移到 public/data/agent头像/）
|
|||
|
|
|
|||
|
|
### public/data/ 违规情况
|
|||
|
|
- [ ] 存放了 .ts 文件（应移到 src/data/）
|
|||
|
|
- [ ] 存放了 .js 文件（应移到 src/data/）
|
|||
|
|
- [ ] 存放了业务逻辑 JSON（应移到 src/data/）
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
## 📝 维护建议
|
|||
|
|
|
|||
|
|
1. **定期检查**: 确保文件归档符合规范
|
|||
|
|
2. **命名规范**: 使用描述性文件名（如：店面图片_正门.jpg）
|
|||
|
|
3. **路径引用**:
|
|||
|
|
- src/data/ 使用 `import` 引用
|
|||
|
|
- public/data/ 使用 `/data/...` URL 引用
|
|||
|
|
4. **软链接维护**: 不要删除或重建已存在的软链接
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
## 最后更新
|
|||
|
|
2025-10-01
|