环境准备与启动

环境要求

工具	版本
Node.js	`>= 20`
pnpm	`10.4.1`（建议用 corepack 锁定）

# 启用 corepack 并锁定 pnpm 版本
corepack enable
corepack prepare pnpm@10.4.1 --activate

安装依赖

在仓库根目录执行（pnpm workspace 会安装所有包）：

pnpm install

onlyBuiltDependencies 已在根 package.json 中声明（如 esbuild、sharp、msw、simple-git-hooks），首次安装会自动构建这些原生依赖。

启动开发服务器

# 启动全部（Turborepo 并行）
pnpm dev

# 仅启动 admin 应用
pnpm --filter skyroc-admin dev

Admin 应用默认监听 http://localhost:9527（host 0.0.0.0，自动打开浏览器）。

注意：apps/admin 的 predev 脚本会先构建 @skyroc/web-admin-vite 包（因为 vite.config.ts 依赖它的 defineConfig）。首次启动会稍慢。

开发模式与环境变量

应用支持多 mode（.env / .env.test / .env.prod）：

pnpm --filter skyroc-admin dev        # vite --mode test
pnpm --filter skyroc-admin dev:prod   # vite --mode prod

常用环境变量（节选）：

变量	说明
`VITE_AUTH_ROUTE_MODE`	`static`（前端静态权限）/ `dynamic`（后端下发路由）
`VITE_ROUTE_HOME`	登录后默认首页路径，如 `/home`
`VITE_HTTP_PROXY`	`Y` 时启用开发代理 `/proxy-default`
`VITE_STORAGE_PREFIX`	本地存储 key 前缀

构建

# 构建所有包与应用
pnpm build

# 仅构建 admin
pnpm --filter skyroc-admin build        # vite build --mode prod
pnpm --filter skyroc-admin build:test   # vite build --mode test

常用根命令

pnpm dev          # 启动开发服务器（turbo run dev）
pnpm build        # 构建所有包（turbo run build）
pnpm lint         # 代码检查（turbo run lint）
pnpm typecheck    # 类型检查（turbo run typecheck）
pnpm test         # 运行单元/集成测试（turbo run test）
pnpm test:e2e     # 运行 E2E 测试
pnpm format       # 全仓库格式化（oxfmt）
pnpm format:check # 仅检查格式（CI 用）
pnpm clean        # 清理构建产物

脚手架命令（`sa`）

项目内置 CLI 工具 @skyroc/scripts（可执行命令 sa），用于自动化：

pnpm create:admin            # 基于内置模板创建新 admin 应用
pnpm sync:admin-template     # 从 apps/admin 同步模板
pnpm check:admin-template    # 检查模板是否同步

目录从哪看起

想了解整体结构 → 目录结构总览
想理解包怎么组织 → Monorepo 架构
想改业务页面 → Admin 应用总览

环境准备与启动

On this page