create-tengits-app 1.0.7 → 1.1.1

package/README.md

@@ -22,6 +22,7 @@
 - 🔧 **开发工具** - ESLint、PostCSS 等完整工具链
 - 📦 **Monorepo** - 基于 pnpm workspace 的包管理
 - 🎯 **生产就绪** - 开箱即用的生产环境配置
+- 🏢 **多项目支持** - 包含普通前端项目、文档管理系统和TTOS客户端项目
 
 ## 🚀 快速开始
 
@@ -92,51 +93,187 @@ pnpm create react-rsbuild-app
 ```
 my-awesome-project/
 ├── packages/
-│   └── main/                  # 主应用包
+│   ├── main/                  # 普通前端项目
+│   │   ├── src/
+│   │   │   ├── components/    # 可复用组件
+│   │   │   ├── pages/         # 页面组件
+│   │   │   │   ├── Home/      # 首页
+│   │   │   │   └── Login/     # 登录页
+│   │   │   ├── styles/        # 样式文件
+│   │   │   ├── types/         # TypeScript 类型定义
+│   │   │   ├── utils/         # 工具函数
+│   │   │   ├── App.tsx        # 应用主组件
+│   │   │   ├── index.jsx      # 应用入口
+│   │   │   ├── routes.tsx     # 路由配置
+│   │   │   └── menus.jsx      # 菜单配置
+│   │   ├── public/            # 静态资源
+│   │   │   ├── locales/       # 国际化文件
+│   │   │   └── ...
+│   │   ├── package.json       # 包配置文件
+│   │   ├── rsbuild.config.ts  # Rsbuild 配置
+│   │   ├── tailwind.config.js # Tailwind 配置
+│   │   └── tsconfig.json      # TypeScript 配置
+│   │
+│   ├── docs/                  # 产品全生命周期文档管理项目
+│   │   ├── pages/             # 文档页面
+│   │   │   ├── requirements/  # 需求文档
+│   │   │   ├── designs/       # 设计文档
+│   │   │   ├── api/           # 接口文档
+│   │   │   ├── develop/       # 开发文档
+│   │   │   ├── logs/          # 更改日志
+│   │   │   └── test/          # 测试文档
+│   │   ├── package.json       # 文档项目配置
+│   │   ├── vite.config.ts     # Vite 配置
+│   │   └── tsconfig.json      # TypeScript 配置
+│   │
+│   └── client/                # TTOS客户端项目
 │       ├── src/
-│       │   ├── components/    # 可复用组件
-│       │   ├── pages/         # 页面组件
+│       │   ├── components/    # 客户端组件
+│       │   ├── pages/         # 客户端页面
 │       │   │   ├── Home/      # 首页
-│       │   │   └── Login/     # 登录页
-│       │   ├── styles/        # 样式文件
-│       │   ├── types/         # TypeScript 类型定义
+│       │   │   ├── Login/     # 登录页
+│       │   │   ├── BIViewer/  # BI查看器
+│       │   │   ├── ExcelViewer/ # Excel查看器
+│       │   │   └── Example/   # 示例页面
+│       │   ├── types/         # 类型定义
 │       │   ├── utils/         # 工具函数
-│       │   ├── App.tsx        # 应用主组件
+│       │   ├── AppNew.tsx     # 应用主组件
 │       │   ├── index.jsx      # 应用入口
 │       │   ├── routes.tsx     # 路由配置
-│       │   └── menus.jsx      # 菜单配置
-│       ├── public/            # 静态资源
-│       │   ├── locales/       # 国际化文件
-│       │   └── ...
-│       ├── package.json       # 包配置文件
+│       │   ├── menus.tsx      # 菜单配置（由租户端创建）
+│       │   └── configSystemData.ts # 系统配置
+│       ├── package.json       # 客户端配置
 │       ├── rsbuild.config.ts  # Rsbuild 配置
-│       ├── tailwind.config.js # Tailwind 配置
 │       └── tsconfig.json      # TypeScript 配置
+│
+├── bin/                       # 脚本目录
+│   ├── cli.js                 # 脚手架主脚本
+│   └── setup-ttos.js          # TTOS项目依赖安装脚本
 ├── pnpm-workspace.yaml        # pnpm workspace 配置
 ├── package.json               # 根包配置
 ├── eslint.config.mjs          # ESLint 配置
 └── README.md                  # 项目说明
 ```
 
+## 🏗️ 项目说明
+
+### 📦 Main 项目 - 普通前端项目
+
+**用途**：标准的 React 前端应用项目
+
+**特点**：
+- 基于 React 18 + Rsbuild + TypeScript
+- 集成 Tailwind CSS + Ant Design
+- 支持国际化（i18n）
+- 响应式设计
+- 完整的开发工具链
+
+**适用场景**：
+- 企业级前端应用开发
+- 管理后台系统
+- 用户界面应用
+
+### 📚 Docs 项目 - 产品全生命周期文档管理
+
+**用途**：完整的产品文档管理系统
+
+**特点**：
+- 基于 Vite + React + MDX
+- 支持 Markdown 和 MDX 格式
+- 自动生成文档站点
+- 响应式文档界面
+
+**包含模块**：
+- **需求文档**：PRD、用户故事、功能规格
+- **设计文档**：UI设计稿、设计规范、组件说明
+- **接口文档**：API规范、请求响应示例
+- **开发文档**：环境搭建、代码规范、部署指南
+- **更改日志**：版本变更记录
+- **测试文档**：测试计划、用例、报告
+
+**适用场景**：
+- 项目文档管理
+- 技术文档维护
+- 团队协作文档
+
+### 🖥️ Client 项目 - TTOS客户端项目
+
+**用途**：TTOS（腾路操作系统）客户端应用
+
+**特点**：
+- 必须安装TTOS项目依赖
+- 根据接口服务地址显示不同客户端数据
+- 客户端菜单由租户端创建
+- 自定义开发只需在代码中配置路由
+
+**核心功能**：
+- 多租户支持
+- 动态菜单配置
+- 系统集成能力
+- 可扩展的页面组件
+
+**TTOS依赖项目**：
+- **BI**：数据分析平台
+- **Bisheng**：毕昇AI平台
+- **liteFlow**：轻量级工作流引擎
+- **saas**：SaaS服务平台
+- **tuiLowCode**：TUI低代码平台
+
+**适用场景**：
+- 企业级客户端应用
+- 多租户SaaS平台
+- 集成多个子系统的统一客户端
+
 ## 🛠️ 可用脚本
 
 在项目目录中，你可以运行：
 
-### pnpm
-版本：9.15.9
+### 根目录脚本
 
 ### `pnpm start`
-启动开发服务器，通常在 [http://localhost:3000](http://localhost:3000) 访问
+启动主项目开发服务器（packages/main）
 
 ### `pnpm build`
-构建生产版本到 `dist` 目录
+构建主项目生产版本
 
 ### `pnpm preview`
-预览生产构建版本
+预览主项目生产构建版本
 
 ### `pnpm doctor`
 检查项目配置和依赖
 
+### `pnpm setup-ttos`
+安装TTOS项目依赖（运行 bin/setup-ttos.js）
+
+### 各项目独立脚本
+
+#### Main 项目
+```bash
+cd packages/main
+pnpm start        # 启动开发服务器 (端口: 3013)
+pnpm build        # 构建生产版本
+pnpm preview      # 预览生产版本
+```
+
+#### Docs 项目
+```bash
+cd packages/docs
+pnpm dev          # 启动文档开发服务器
+pnpm build        # 构建文档站点
+pnpm ssr          # 服务端渲染构建
+```
+
+#### Client 项目
+```bash
+cd packages/client
+pnpm start        # 启动客户端开发服务器
+pnpm start:test   # 启动测试环境
+pnpm start:pre    # 启动预发布环境
+pnpm build        # 构建生产版本
+pnpm build:test   # 构建测试版本
+pnpm build:pre    # 构建预发布版本
+```
+
 ## 🎨 技术栈
 
 - **构建工具**: [Rsbuild](https://rsbuild.dev/) - 基于 Rspack 的高性能构建工具
@@ -186,6 +323,91 @@ module.exports = {
 
 编辑 `packages/main/tsconfig.json` 来调整 TypeScript 设置。
 
+## 🖥️ TTOS客户端项目使用指南
+
+### 安装TTOS依赖
+
+在开始使用Client项目之前，必须先安装TTOS项目依赖：
+
+```bash
+# 在项目根目录执行
+pnpm setup-ttos
+```
+
+这个命令会：
+1. 创建 `TTOS` 目录
+2. 克隆所有TTOS相关项目（BI、Bisheng、liteFlow、saas、tuiLowCode）
+3. 安装各项目的依赖
+4. 建立全局链接关系
+
+### 客户端配置
+
+#### 1. 系统配置
+
+编辑 `packages/client/src/configSystemData.ts` 配置系统参数：
+
+```typescript
+// 根据环境变量配置不同的服务地址
+const {
+  REACT_APP_SYSTEM_ID,
+  REACT_APP_PRE_BETA,
+  // ... 其他环境变量
+} = import.meta.env;
+
+export default function configSystemData() {
+  window.systemId = REACT_APP_SYSTEM_ID;
+  // 配置系统数据...
+}
+```
+
+#### 2. 菜单配置
+
+客户端菜单由租户端创建，在 `packages/client/src/menus.tsx` 中配置：
+
+```typescript
+// 菜单由后端接口动态获取
+export async function getUserAndMenu({ cookie, tenantPara = {} }) {
+  // 获取用户信息和菜单数据
+  return await httpClient.post('/ttos/user/getUserInfo', {
+    applicationId: tenantPara.applicationId,
+    platformType: PlatformType.Client,
+  });
+}
+```
+
+#### 3. 路由配置
+
+自定义开发只需在 `packages/client/src/routes.tsx` 中配置路由：
+
+```typescript
+// 添加新的页面路由
+const routes = [
+  {
+    path: '/your-page',
+    component: YourPageComponent,
+  },
+  // ... 其他路由
+];
+```
+
+### 多环境支持
+
+Client项目支持多环境配置：
+
+- **开发环境**: `pnpm start`
+- **测试环境**: `pnpm start:test`
+- **预发布环境**: `pnpm start:pre`
+
+### 页面组件
+
+Client项目包含以下页面组件：
+
+- **Home**: 首页
+- **Login**: 登录页
+- **BIViewer**: BI数据查看器
+- **ExcelViewer**: Excel文件查看器
+- **Example**: 示例页面
+
 ## 🌍 国际化
 
 项目内置了完整的国际化支持：
@@ -202,16 +424,56 @@ module.exports = {
 
 ## 📦 部署
 
-### 构建项目
+### 构建所有项目
 ```bash
+# 构建主项目
 pnpm build
+
+# 构建文档项目
+cd packages/docs && pnpm build
+
+# 构建客户端项目
+cd packages/client && pnpm build
 ```
 
-### 静态部署
+### 各项目部署
+
+#### Main 项目部署
+```bash
+cd packages/main
+pnpm build
+```
 构建后的文件在 `packages/main/dist` 目录中，可以部署到任何静态文件服务器。
 
+#### Docs 项目部署
+```bash
+cd packages/docs
+pnpm build
+```
+构建后的文档站点在 `packages/docs/dist` 目录中，可以部署到静态文件服务器或CDN。
+
+#### Client 项目部署
+```bash
+cd packages/client
+# 根据环境选择构建命令
+pnpm build        # 生产环境
+pnpm build:test   # 测试环境
+pnpm build:pre    # 预发布环境
+```
+构建后的文件在 `packages/client/dist` 目录中。
+
 ### 环境配置
-项目支持多环境配置：
+
+#### Main 项目环境
+- 开发环境: `pnpm start`
+- 生产构建: `pnpm build`
+
+#### Docs 项目环境
+- 开发环境: `pnpm dev`
+- 生产构建: `pnpm build`
+- SSR构建: `pnpm ssr`
+
+#### Client 项目环境
 - 开发环境: `pnpm start`
 - 测试环境: `pnpm start:test`
 - 预发布环境: `pnpm start:pre`
@@ -229,6 +491,16 @@ pnpm build
 
 ## 📝 更新日志
 
+### v1.1.1
+- 🎉 多项目架构支持
+- ✨ 新增 Docs 项目 - 产品全生命周期文档管理
+- 🖥️ 新增 Client 项目 - TTOS客户端项目
+- 🔧 新增 TTOS 依赖安装脚本
+- 📚 完整的文档管理系统（需求、设计、接口、开发、测试、日志）
+- 🏢 多租户客户端支持
+- 🎯 动态菜单配置
+- 🔗 系统集成能力
+
 ### v1.0.0
 - 🎉 初始版本发布
 - ✨ 支持 React 18 + Rsbuild