Appearance
本地开发与构建
前置条件
- Node.js、pnpm
- MySQL(ZenStack / 应用数据)
- Redis(Sys 登录会话等)
环境文件
backend/.env:由backend/.env.example复制。至少配置DATABASE_URL、JWT_SECRET(网关与 Sys 必须一致)、REDIS_*、SYS_SERVICE_URL、ACC_SERVICE_URL。frontend/.env:由frontend/.env.example复制,例如VITE_API_BASE_URL指向网关(默认http://localhost:3000)。
数据库与 ZenStack
在 backend/ 目录:
bash
pnpm run zen:generate
pnpm run zen:pushzen:generate:根据zenstack/schema.zmodel生成客户端与类型。zen:push:将 schema 同步到数据库(生产环境请改用迁移策略)。
常用命令(仓库根目录)
| 命令 | 说明 |
|---|---|
pnpm install | 安装 workspace 依赖 |
pnpm dev | 并行启动 gateway、sys、acc、Vite 前端 |
pnpm dev:backend | 仅三后端 |
pnpm dev:web | 仅前端 |
pnpm build | 后端 build + 前端 build |
pnpm docs:dev / pnpm --filter taskflow-docs dev | 仅启动本 VitePress 文档站(5174,与前端 5173 区分) |
开发时浏览器访问 前端端口(默认 5173),由 Vite 将 /api 代理到网关,再由网关转发 Sys / Acc。
文档站点
文档开发服务器固定为 5174(在 docs/.vitepress/config.ts 的 vite.server.port),避免与前端 pnpm dev:web 的 5173 冲突。
bash
pnpm docs:dev
# 或
pnpm --filter taskflow-docs dev浏览器打开 http://localhost:5174。
构建与预览静态站点:
bash
pnpm docs:build
pnpm docs:preview预览默认使用 4174(vite.preview.port),与前端 vite preview 常用 4173 错开。