@coze-arch/cli 0.0.1-alpha.afefde → 0.0.1-alpha.b287c1

package/lib/__templates__/vite/README.md

@@ -1,6 +1,12 @@
 # <%= appName %>
 
-这是一个基于 TypeScript + Vite + Tailwind CSS 的轻量级 Web 应用项目，由扣子编程 CLI 创建。
+这是一个基于 Express + Vite + TypeScript + Tailwind CSS 的全栈 Web 应用项目，由扣子编程 CLI 创建。
+
+**核心特性：**
+- 🚀 前端：Vite + TypeScript + Tailwind CSS
+- 🔧 后端：Express + TypeScript，提供 RESTful API
+- 🔥 开发模式：Vite HMR + Express API，单进程启动
+- 📦 生产模式：Express 静态服务 + API，高性能部署
 
 ## 快速开始
 
@@ -33,19 +39,149 @@ coze start
 ## 项目结构
 
 ```
-├── index.html              # HTML 入口文件
-├── src/
-│   ├── index.ts           # 应用入口（初始化）
-│   ├── main.ts            # 主逻辑文件
-│   └── index.css          # 全局样式（包含 Tailwind 指令）
-├── vite.config.ts         # Vite 配置
-├── tailwind.config.ts     # Tailwind CSS 配置
-└── tsconfig.json          # TypeScript 配置
+├── server/                # 后端服务器目录
+│   ├── index.ts          # express 服务器入口
+│   ├── routes/           # API 路由目录
+│   │   └── index.ts      # 路由定义
+│   └── vite.ts           # Vite 集成逻辑
+├── src/                   # 前端源码目录
+│   ├── index.ts          # 前端应用入口（初始化）
+│   ├── main.ts           # 前端主逻辑文件
+│   └── index.css         # 全局样式（包含 Tailwind 指令）
+├── index.html            # HTML 入口文件
+├── vite.config.ts        # Vite 配置
+├── tailwind.config.ts    # Tailwind CSS 配置
+└── tsconfig.json         # TypeScript 配置
 ```
 
+**目录说明：**
+
+- **`server/`** - 后端服务器代码
+  - `server.ts` - 服务器主入口，负责创建和启动 Express 应用
+  - `routes/` - API 路由模块，支持按功能拆分路由
+  - `vite.ts` - Vite 开发服务器和静态文件服务集成
+
+- **`src/`** - 前端应用代码
+  - 所有前端相关代码都在这里
+
+**工作原理：**
+
+- **开发模式** (`coze dev`)：
+  - 运行 `server/server.ts` 启动 Express 服务器
+  - Vite 以 middleware 模式集成到 Express
+  - 前端支持 HMR（热模块替换）
+  - 后端 API 和前端在同一进程，端口 <%= port %>
+
+- **生产模式** (`coze start`)：
+  - `coze build` 构建前端 → `dist/` 目录
+  - `coze build` 构建后端 → `dist-server/index.js` (CommonJS 格式)
+  - 运行 `dist-server/index.js` 启动生产服务器
+  - Express 服务静态文件 + API 路由
+  - 单一 Node.js 进程，轻量高效
+
 ## 核心开发规范
 
-### 1. 样式开发
+### 1. 后端 API 开发
+
+**添加新的 API 路由**
+
+在 `server/routes/index.ts` 中添加路由：
+
+```typescript
+// GET 请求示例
+router.get('/api/users', (req, res) => {
+  res.json({
+    users: [
+      { id: 1, name: 'Alice' },
+      { id: 2, name: 'Bob' },
+    ],
+  });
+});
+
+// POST 请求示例
+router.post('/api/users', (req, res) => {
+  const userData = req.body;
+  // 处理业务逻辑
+  res.json({
+    success: true,
+    user: userData,
+  });
+});
+
+// 动态路由参数
+router.get('/api/users/:id', (req, res) => {
+  const userId = req.params.id;
+  res.json({
+    id: userId,
+    name: 'User ' + userId,
+  });
+});
+```
+
+**拆分路由模块**（推荐）
+
+当路由变多时，可以按功能拆分：
+
+```typescript
+// server/routes/users.ts
+import { Router } from 'express';
+
+const router = Router();
+
+router.get('/api/users', (req, res) => {
+  // 用户列表逻辑
+  res.json({ users: [] });
+});
+
+router.post('/api/users', (req, res) => {
+  // 创建用户逻辑
+  res.json({ success: true });
+});
+
+export default router;
+```
+
+然后在 `server/server.ts` 中注册：
+
+```typescript
+import usersRouter from './routes/users';
+
+// 注册路由
+app.use(usersRouter);
+```
+
+**前端调用 API**
+
+```typescript
+// GET 请求
+async function getUsers() {
+  const response = await fetch('/api/users');
+  const data = await response.json();
+  console.log(data);
+}
+
+// POST 请求
+async function createUser(name: string) {
+  const response = await fetch('/api/users', {
+    method: 'POST',
+    headers: {
+      'Content-Type': 'application/json',
+    },
+    body: JSON.stringify({ name }),
+  });
+  const data = await response.json();
+  console.log(data);
+}
+```
+
+**API 最佳实践**
+
+- ✅ 所有 API 路由以 `/api` 开头，避免与前端路由冲突
+- ✅ 使用 RESTful 设计：GET 查询、POST 创建、PUT 更新、DELETE 删除
+- ✅ 返回统一的响应格式：`{ success: boolean, data?: any, error?: string }`
+- ✅ 添加错误处理和参数验证
+
+### 2. 样式开发
 
 **使用 Tailwind CSS**
 
@@ -219,17 +355,31 @@ console.log(apiUrl); // https://api.example.com
 
 ## 技术栈
 
-- **构建工具**: Vite 6.x
+**前端：**
+- **构建工具**: Vite 7.x
 - **语言**: TypeScript 5.x
 - **样式**: Tailwind CSS 3.x
+
+**后端：**
+- **框架**: Express 4.x
+- **内置中间件**: express.json(), express.urlencoded(), express.static()
+
+**工具：**
 - **包管理器**: pnpm 9+
+- **运行时**: Node.js 18+
+- **开发工具**: tsx (TypeScript 执行器)
 
 ## 参考文档
 
+**前端：**
 - [Vite 官方文档](https://cn.vitejs.dev/)
 - [TypeScript 官方文档](https://www.typescriptlang.org/zh/docs/)
 - [Tailwind CSS 文档](https://tailwindcss.com/docs)
 
+**后端：**
+- [Express 官方文档](https://expressjs.com/)
+- [Express 中文文档](https://expressjs.com/zh-cn/)
+
 ## 重要提示
 
 1. **必须使用 pnpm** 作为包管理器
@@ -237,3 +387,32 @@ console.log(apiUrl); // https://api.example.com
 3. **使用 Tailwind CSS** 进行样式开发，支持响应式和暗色模式
 4. **环境变量必须以 `VITE_` 开头** 才能在客户端代码中访问
 5. **开发时使用 `coze dev`**，支持热更新和快速刷新
+6. **API 路由以 `/api` 开头**，避免与前端路由冲突
+7. **单进程架构**：开发和生产环境都是前后端在同一进程中运行
+
+## 常见问题
+
+**Q: 如何分离前后端端口？**
+
+如果需要前后端分离部署，可以：
+- 前端：使用 `npx vite` 单独启动（默认端口 5173）
+- 后端：修改 `server.ts`，移除 Vite middleware，单独启动
+
+**Q: 如何添加数据库？**
+
+```bash
+# 安装数据库客户端（以 PostgreSQL 为例）
+pnpm add pg
+pnpm add -D @types/pg
+
+# 在 server.ts 中使用
+import { Pool } from 'pg';
+const pool = new Pool({ connectionString: process.env.DATABASE_URL });
+```
+
+**Q: 如何部署？**
+
+1. 运行 `coze build` 构建前后端
+2. 将整个项目上传到服务器
+3. 运行 `pnpm install --prod`
+4. 运行 `coze start` 启动服务

package/lib/__templates__/vite/_gitignore

@@ -5,6 +5,7 @@ node_modules/
 
 # Production build
 dist/
+dist-server/
 build/
 out/
 

package/lib/__templates__/vite/eslint.config.mjs

@@ -5,5 +5,10 @@ import { defineConfig, globalIgnores } from 'eslint/config';
 export default defineConfig([
   eslint.configs.recommended,
   ...tseslint.configs.recommended,
-  globalIgnores(['dist/**', 'node_modules/**']),
+  globalIgnores([
+    'dist/**',
+    'dist-server/**',
+    'node_modules/**',
+    'scripts/**',
+  ]),
 ]);

package/lib/__templates__/vite/package.json

@@ -1,7 +1,7 @@
 {
   "name": "<%= appName %>",
   "version": "1.0.0",
-  "description": "Vanilla TypeScript application with Vite (HTML + CSS + TS)",
+  "description": "Vanilla TypeScript application with Express + Vite (HTML + CSS + TS + Node API)",
   "scripts": {
     "build": "bash ./scripts/build.sh",
     "dev": "bash ./scripts/dev.sh",
@@ -10,13 +10,23 @@
     "start": "bash ./scripts/start.sh",
     "ts-check": "tsc -p tsconfig.json"
   },
+  "dependencies": {
+    "@supabase/supabase-js": "2.95.3",
+    "dotenv": "^17.2.3",
+    "express": "^4.21.2"
+  },
   "devDependencies": {
+    "@types/express": "^5.0.0",
+    "@types/node": "^22.10.5",
     "autoprefixer": "^10.4.20",
-    "coze-coding-dev-sdk": "^0.7.0",
+    "coze-coding-dev-sdk": "^0.7.16",
+    "esbuild": "^0.24.2",
     "eslint": "^9",
     "only-allow": "^1.2.2",
     "postcss": "^8.4.49",
     "tailwindcss": "^3.4.17",
+    "tsup": "^8.3.5",
+    "tsx": "^4.19.2",
     "typescript": "^5.6.0",
     "typescript-eslint": "^8",
     "vite": "^7.2.4"
@@ -24,5 +34,11 @@
   "packageManager": "pnpm@9.0.0",
   "engines": {
     "pnpm": ">=9.0.0"
+  },
+  "pnpm": {
+    "overrides": {
+      "esbuild": "^0.27.2",
+      "is-generator-function": "1.0.10"
+    }
   }
 }