本文档由 g2rain-app-template 的
# 本地开发
docs/development/local-development.md 自动同步生成。# 准备环境
- Node.js
>=22 - npm
- 可访问的 main-shell、IAM、Gateway/Basis(联调时)
使用锁文件安装:
npm ci
不要在没有依赖升级需求时用 npm install 重写锁文件。模板包名仍是 属于正常占位符。
# 独立运行
PowerShell:
$env:VITE_RUN_MODE = 'alone'
$env:VITE_SERVER_PORT = '3001'
$env:VITE_BACKEND_ORIGIN = 'http://localhost:8080'
npm run dev
Bash:
VITE_RUN_MODE=alone VITE_SERVER_PORT=3001 VITE_BACKEND_ORIGIN=http://localhost:8080 npm run dev
也可以通过 URL 查询参数 ?mode=alone 覆盖运行模式。独立模式会自行处理 SSO、Token 和资源加载。
# 集成运行
默认空模式是集成意图。子应用应由 main-shell 通过 qiankun 加载;直接访问子应用地址会跳转到 main-shell 的 /main/redirect 网关路径。
跨端口开发时设置:
$env:VITE_MAIN_SHELL_ORIGIN = 'http://localhost:3000'
$env:VITE_MAIN_SHELL_REDIRECT_PREFIX = '/main/redirect'
npm run dev
qiankun mount 至少需要 container 和唯一 appKey。正常业务联调还需要 token、tokenKid,以及按认证方案提供的 client。
# 构建与预览
npm run build
npm run preview
npm run build 是当前唯一仓库级验证命令,包含 vue-tsc 和 Vite 构建。仓库目前没有独立 unit/e2e/lint 脚本,不能把“build 通过”描述为完整测试覆盖。
# 开发检查
- 访问后立即跳 main-shell:确认是否忘记设置
mode=alone,这是默认行为而非死循环。 - 端口不是
.env中的3000:Vite 配置读取process.env.VITE_SERVER_PORT,未设置时实际回退3001。 - 页面不出现:检查后端页面资源的
linkPath和views/route-map.ts是否一致。 - 权限不生效:检查资源接口、静态
v-permission和生成后的资源 JSON。 - SSO 回调失败:检查 Context Path、Redirect URI、IAM 地址和 main-shell 路由是否成对配置。
更多问题见故障排查。