Add the NestJS backend with PostgreSQL and Redis, local setup, and independent frontend and fullstack source archives. Enforce permissions across redirects, let users dismiss the 403 page, and restore missing translation warnings in development.
7.1 KiB
发行版本与快速启动
同一套前端通过源码导出提供独立使用方式。Admin、文档和公共包之间保留明确依赖边界,Mock 与自有后端遵循同一套 API 契约。源码归档包含可编辑的工程文件,需要安装依赖并构建后运行。
纯前端发行包
在仓库根目录执行:
pnpm dist:frontend
输出目录为 dist/distributions/,包含 ray-template-frontend-<version>/ 和同名 .tar.gz。解压后进入源码目录,使用仓库指定的 Node.js 26.13.0 与 pnpm 12.16.1:
pnpm install --frozen-lockfile
pnpm dev
默认打开 /ray-template/,通过 MSW 体验登录、用户管理、路由和其他示例。纯前端包保留 Admin、文档、10 个共享包及必要工具;不包含后端工作区、数据库驱动、Redis 客户端、服务端启动脚本或数据库配置。前端开发、构建和文档使用不需要 Docker。
接入自己的服务时配置 VITE_API_BASE_URL、VITE_API_MOCK=false,具体协议见服务端接入。这些前端变量会进入浏览器产物,只能放公开配置。
发行物追溯
归档内的 distribution.json 记录:
- 发行类型和版本。
- 来源 Git 提交及是否含未提交改动;没有 Git 信息时保留已知的来源信息。
- 实际包含的 workspace 清单和源码文件数量。
- 导出内容的 SHA-256 摘要。
导出会按依赖图保留所需工作区、裁剪锁文件、移除不可用命令与专属说明,并排除 .git、node_modules、本地环境配置、凭据、构建结果和临时验证资料。pnpm dist:check 检查导出计划和依赖完整性;干净环境中的安装、构建、运行需要另行验证。
导出命令只生成本地源码目录和归档。
全栈发行包
在完整仓库运行:
pnpm dist:fullstack
同一目录会生成 ray-template-fullstack-<version>/ 与同名 .tar.gz。它包含相同的前端源码以及 apps/server、数据库迁移、Redis 配置和启动工具。后端采用 NestJS 12.3.3、Prisma 7.10.1、PostgreSQL 18,Redis 客户端为 6.3.1;Compose 配置使用 Redis 8.2.11。具体锁定版本以发行包清单和锁文件为准。
本地开发
安装依赖并准备 Docker Compose,然后运行:
pnpm fullstack:setup
pnpm dev:full
setup 首次创建 apps/server/.env.local,生成数据库、Redis 和管理员随机密码,启动 PostgreSQL 与 Redis,执行迁移并初始化管理员。配置文件权限按私有文件创建,不应提交、上传或放进前端变量。管理员账号与密码从该文件读取;Mock 的 123456 只用于前端演示。
再次执行 setup 会复用配置、保留已有账号和数据库内容。dev:full 等待后端就绪后再启动前端,通过 Vite 将同源 /api/ 请求代理给后端,并关闭 Mock。默认地址为 http://127.0.0.1:9527/ray-template/;可用 ADMIN_DEV_PORT 和 PORT 分别指定前端和后端端口。按 Ctrl+C 关闭开发进程;pnpm fullstack:stop 停止 Compose 服务并保留数据卷。
使用已有数据库与 Redis
将 DATABASE_URL 和 REDIS_URL 放入当前进程的安全环境中,然后执行:
pnpm fullstack:setup --external
pnpm dev:full
--external 跳过 Docker 服务启动,仍执行迁移和初始化。已有 apps/server/.env.local 时保留该文件,进程环境优先。应使用为本项目准备的数据库;迁移和初始化会创建或更新本项目的数据结构。停止外部数据服务由其部署环境负责。
创建真实登录账号
用户管理页创建的是用户资料,默认没有登录凭据。通过安全环境提供 CREDENTIAL_USERNAME 与 CREDENTIAL_PASSWORD,再执行 pnpm server:credential:set。密码要求 12–128 个字符;该命令设置凭据并撤销该账号已有会话。避免将密码直接写入 shell 历史。
重复执行 setup 不会重置管理员密码。需要更换密码时,同样使用显式的凭据命令。服务端存储密码派生值和会话令牌摘要,认证继续使用已有 Bearer 契约。
服务与运行检查
| 命令或接口 | 用途 |
|---|---|
pnpm server:build |
生成 Prisma Client 并构建独立服务端产物 |
pnpm server:start |
从服务端构建产物启动 |
pnpm server:check |
服务端类型、单元/平台测试和构建 |
pnpm server:test:integration |
使用 TEST_DATABASE_URL、TEST_REDIS_URL 验证真实存储与 HTTP 行为 |
GET /api/health/live |
进程存活检查 |
GET /api/health/ready |
PostgreSQL 与 Redis 就绪检查 |
全栈包含配置校验、接口授权、会话撤销、Redis 限流、安全响应头、CORS、请求 ID、脱敏日志和操作审计。Redis 不可用时管理接口返回 503,不切换到每进程的临时认证或限流数据。缓存只用于可重建的演示读取结果,权限和会话每次从数据库核验。
生产模式默认关闭演示接口,并从后端提供的运行菜单中移除演示页面。路由编辑器仍可维护完整配置。真实后端请求失败不会回退到 Mock。
容器启动
执行 pnpm fullstack:setup 后,可以使用 Compose 的 app profile 启动静态前端、NestJS 和数据服务:
docker compose -p ray-template --env-file apps/server/.env.local \
-f deploy/compose.yaml --profile app up --build -d --wait
默认打开 http://127.0.0.1:8080/ray-template/。设置 APP_PORT 可改变本机入口端口;代理和自定义域名场景应把实际浏览器来源填入 APP_ORIGINS。容器用 APP_DEMO_ENABLED=true 开启演示。Nginx 覆盖转发头,后端仅信任 Nginx 的固定地址,且不映射宿主机端口。代理网段冲突时,设置 APP_PROXY_NETWORK 为其他私有 IPv4 前三段(例如 172.30.68)。默认连接串适用于初始化生成的 URL 安全密码;自定义密码需要在 APP_DATABASE_URL、APP_REDIS_URL 中正确编码。
node deploy/smoke.mjs 使用临时 Compose 项目检查迁移、前端构建、登录、CORS、演示开关和代理限流,并清理测试容器与数据卷。对外部署仍需要为目标环境验证 HTTPS、实际代理链、持久化存储和备份。
生成分支与 Release 资产
维护者在 GitHub Actions 从 main 手动运行 Source distributions。默认只验证并上传本次运行的归档。要更新生成的 frontend 分支,选择 sync_frontend;该分支从主线导出,不用于独立开发。要给已有 Release 附加两个源码包及 SHA-256 校验文件,另行填写 release_tag。工作流检查标签版本及提交、验证归档,并保留已上传的同名资产。