# 快速开始指南

> **文档版本**: v1.0.0  
> **创建日期**: 2026-05-25  
> **最后更新**: 2026-05-25  
> **文档作者**: 开发团队  
> **文档状态**: 已发布  
> **适用范围**: 所有开发者

## 目录

- [一、前置条件](#一前置条件)
- [二、环境搭建](#二环境搭建)
- [三、项目启动](#三项目启动)
- [四、常用命令](#四常用命令)

---

## 一、前置条件

在开始之前，请确保你已经安装：

| 工具 | 版本要求 | 说明 |
|------|---------|------|
| **Node.js** | >= 20.x | 运行环境 |
| **pnpm** | >= 8.x | 包管理器 |
| **Git** | 最新 | 版本控制 |
| **Docker** | 最新 | 容器化（可选） |

---

## 二、环境搭建

### 2.1 克隆项目

```bash
git clone <repository-url>
cd FischerX
```

### 2.2 安装依赖

```bash
pnpm install
```

### 2.3 环境变量配置

复制 `.env.example` 为 `.env` 并填写配置：

```bash
cp .env.example .env
```

---

## 三、项目启动

### 3.1 启动开发环境

```bash
# 启动所有服务
pnpm dev

# 或者只启动 Web 应用
pnpm --filter web dev

# 或者只启动 API 服务
pnpm --filter api dev
```

### 3.2 访问应用

- Web 应用: http://localhost:3000
- API 文档: http://localhost:4000/api-docs
- 管理后台: http://localhost:3001

---

## 四、常用命令

### 4.1 开发命令

```bash
# 启动所有服务
pnpm dev

# 构建所有包
pnpm build

# 运行测试
pnpm test

# 代码检查
pnpm lint

# 代码格式化
pnpm format
```

### 4.2 Git 工作流

```bash
# 创建新分支
git checkout -b feature/your-feature

# 提交代码
git add .
git commit -m "feat: add your feature"

# 推送到远程
git push origin feature/your-feature
```

---

> **文档维护**: 本文档由开发团队维护，流程变更时更新  
> **反馈渠道**: 如有问题，请提交 Issue  
> **最后更新**: 2026-05-25  
> **文档状态**: 已发布