create-tengits-app/USAGE.md

🚀 快速创建基于 React + Rsbuild + TypeScript + Tailwind CSS + Antd 的现代前端项目脚手架

# 使用指南

## 快速创建项目

### 1. 运行脚手架
```bash
npx create-tengits-app
```

### 2. 输入项目信息
```
🚀 欢迎使用 Tengits 前端脚手架！

请输入项目名称（默认: my-react-app）: my-project
```

### 3. 等待创建完成
脚手架会自动完成以下步骤：
- ✅ 创建项目目录
- ✅ 复制模板文件
- ✅ 配置 package.json
- ✅ 安装项目依赖

### 4. 启动项目
```bash
cd my-project
pnpm start
```

## 项目特性

生成的项目包含以下特性：

### 🛠️ 技术栈
- **React 18** - 最新的 React 版本
- **TypeScript** - 类型安全的 JavaScript
- **Rsbuild** - 快速的构建工具
- **Tailwind CSS** - 实用优先的样式框架
- **Ant Design** - 企业级 UI 组件库

### 🌟 内置功能
- ✅ 路由系统 (React Router)
- ✅ 状态管理 (React Query)
- ✅ 国际化支持 (i18next)
- ✅ HTTP 请求 (fetch)
- ✅ 响应式设计
- ✅ 深色/浅色主题
- ✅ TypeScript 完整支持
- ✅ ESLint 代码规范
- ✅ PostCSS 样式处理

### 📁 目录结构
```
my-project/
├── packages/main/         # 主应用
│   ├── src/
│   │   ├── components/    # 可复用组件
│   │   ├── pages/         # 页面组件
│   │   ├── utils/         # 工具函数
│   │   ├── styles/        # 样式文件
│   │   └── types/         # 类型定义
│   ├── public/            # 静态资源
│   ├── rsbuild.config.ts  # 构建配置
│   └── package.json       # 包配置
├── pnpm-workspace.yaml    # workspace 配置
└── package.json           # 根配置
```

## 开发命令

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

# 构建生产版本
pnpm build

# 预览生产版本
pnpm preview

# 代码检查
pnpm doctor
```

## 环境配置

项目支持多环境配置：

```bash
# 开发环境（默认）
pnpm start

# 测试环境
pnpm start:test

# 预发布环境
pnpm start:pre

# 生产构建
pnpm build
pnpm build:test  # 测试环境构建
pnpm build:pre   # 预发布环境构建
```

## 自定义配置

### 修改构建配置
编辑 `packages/main/rsbuild.config.ts`

### 修改样式主题
编辑 `packages/main/tailwind.config.js`

### 添加路由
编辑 `packages/main/src/routes.tsx`

### 配置国际化
添加语言文件到 `packages/main/public/locales/`

## 部署

### 静态部署
```bash
pnpm build
# 将 packages/main/dist 目录部署到服务器
```

### Docker 部署
```dockerfile
FROM nginx:alpine
COPY packages/main/dist /usr/share/nginx/html
EXPOSE 80
CMD ["nginx", "-g", "daemon off;"]
```

## 常见问题

### Q: 如何修改项目端口？
A: 修改 `packages/main/rsbuild.config.ts` 中的 server 配置

### Q: 如何添加新的 UI 组件？
A: 在 `packages/main/src/components/` 目录下创建新组件

### Q: 如何配置代理？
A: 在 `packages/main/rsbuild.config.ts` 中添加 proxy 配置

### Q: 如何添加环境变量？
A: 创建 `.env` 文件或在 rsbuild 配置中定义

## 技术支持

如需帮助，请：
1. 查看 [官方文档](https://github.com/your-username/create-tengits-app)
2. 提交 [GitHub Issue](https://github.com/your-username/create-tengits-app/issues)
3. 参考 [示例项目](https://github.com/your-username/create-tengits-app/tree/main/examples)