# Finyx Frontend 文档中心

欢迎来到 Finyx Frontend 项目文档中心。本文档提供了项目的完整技术文档和使用指南。

## 📚 文档索引

### 核心文档

1. **[Cursor规则文档](./.cursorrules)**
   - 项目开发规范和代码规范
   - Cursor AI助手的开发规则
   - 代码审查要点

2. **[架构说明文档](./ARCHITECTURE.md)**
   - 项目技术架构
   - 目录结构说明
   - 核心模块详解
   - 数据流和状态管理
   - 开发指南

3. **[API接口文档](./API.md)**
   - HTTP请求封装
   - API使用方式
   - 错误处理
   - 接口示例

4. **[组件使用文档](./COMPONENTS.md)**
   - 全局组件列表
   - 组件API说明
   - 使用示例
   - 自定义组件开发

## 🚀 快速开始

### 环境要求
- Node.js >= 18
- pnpm >= 8

### 安装依赖
```bash
pnpm install
```

### 启动开发服务器
```bash
pnpm dev
```

### 构建生产版本
```bash
pnpm build:prd
```

## 📖 文档使用指南

### 对于新开发者
1. 首先阅读 [架构说明文档](./ARCHITECTURE.md) 了解项目整体结构
2. 查看 [Cursor规则文档](./.cursorrules) 了解开发规范
3. 参考 [组件使用文档](./COMPONENTS.md) 了解可用组件
4. 查看 [API接口文档](./API.md) 了解如何调用接口

### 对于维护者
1. 定期更新 [架构说明文档](./ARCHITECTURE.md) 反映项目变化
2. 保持 [Cursor规则文档](./.cursorrules) 与项目规范同步
3. 新增组件时更新 [组件使用文档](./COMPONENTS.md)
4. 新增API时更新 [API接口文档](./API.md)

## 🔍 文档结构

```
docs/
├── README.md           # 文档索引（本文件）
├── .cursorrules        # Cursor开发规则
├── ARCHITECTURE.md     # 架构说明
├── API.md              # API接口文档
└── COMPONENTS.md       # 组件使用文档
```

## 📝 文档更新记录

文档会随着项目发展持续更新，请定期查看最新版本。

## 🤝 贡献指南

如果发现文档有误或需要补充，请：
1. 提交Issue说明问题
2. 或直接提交PR更新文档

## 📞 联系方式

如有疑问，请联系项目维护团队。

---

**最后更新**: 2025-01-05

