快速上手

目录结构总览

monorepo 顶层目录与各 workspace 的职责一览

仓库共 31 个包packages/** 28 个 + internal/* 3 个),外加 5 个应用(apps/*)和 3 个文档站(docs/*)。本页是这些 workspace 的权威清单——其它页面提到包数量或归属时,以这里为准。

顶层结构

soybean-admin-react/
├── apps/                     # 应用(薄壳)
│   ├── admin/                # 主管理后台 (skyroc-admin)
│   ├── admin-example/        # 示例 admin(页面更全)
│   ├── web-ui-playground/    # Web UI 组件演练场 (skyroc-ui-playground)
│   ├── native-ui-playground/ # Native UI / Expo 演练场
│   └── ruoyi-plus-fast/      # RuoYi-Plus 对接示例
├── packages/                 # 所有 workspace 包(按平台优先组织)
│   ├── @core/                # 跨端运行时基础设施(9 个包)
│   ├── shared/               # 跨端纯类型(ui-types / type-utils)
│   ├── hooks/                # 跨端 React hooks
│   ├── primitives/           # 底层 primitive 库(如 @skyroc/form)
│   ├── web/                  # Web 端能力包(UI / 主题 / 布局 / vite…)
│   ├── native/               # React Native 端(@skyroc/native-ui)
│   └── miniapp/              # 小程序端(预留,workspace glob 已就位)
├── internal/                 # 内部配置包(不发布)
│   ├── tsconfig/             # @skyroc/tsconfig
│   ├── config/               # @skyroc/config(vitest + oxlint)
│   └── uno-config/           # @skyroc/uno-config
├── docs/                     # 文档站(fumadocs)
│   ├── docs/                 # ← 主文档门户(本站点)
│   ├── web-ui-docs/          # Web UI 组件站(独立部署)
│   └── native-ui-docs/       # Native UI 组件站(独立部署)
├── scripts/                  # 仓库级脚本
├── turbo.json                # Turborepo 任务定义
├── pnpm-workspace.yaml       # workspace + catalog + overrides
├── vitest.config.ts          # 根测试配置
├── .oxlintrc.json            # 根 lint 配置
└── .oxfmtrc.json             # 根格式化配置

哪些目录会被识别成 workspace 包,由 pnpm-workspace.yaml 的 glob 决定,见 Monorepo 与 pnpm workspace。注意 packages/webpackages/native 本身不是包,只是平台目录。

packages/@core —— 基础设施层(9 个包)

目录包名职责
types@skyroc/types全局类型声明(零依赖)
utils@skyroc/utils通用工具函数(含 ./web 子入口)
color@skyroc/color颜色处理 & 调色板
axios@skyroc/axios类型安全 HTTP 客户端
state@skyroc/core-stateJotai 状态封装
logger@skyroc/logger跨端日志系统
service@skyroc/service请求 & 查询基础设施
scripts@skyroc/scripts项目自动化 CLI(sa

详见 跨端核心总览

packages/web —— Web 端能力包(11 + 3 个包)

目录包名职责
ui/shadcn@skyroc/web-uiRadix + Tailwind 设计系统
ui/compose@skyroc/web-ui-compose无状态复合组件 + 表格工具
ui/antd@skyroc/web-ui-antdAnt Design 业务组件层
materials@skyroc/materials插槽式布局材料
tailwind-plugin@skyroc/tailwind-pluginTailwind 主题插件
antd-theme@skyroc/adapter-antd-themeOKLCH antd 主题算法
admin-theme@skyroc/web-admin-theme应用层主题管理
admin-layouts@skyroc/web-admin-layouts完整 admin 布局壳
admin-i18n@skyroc/web-admin-i18ni18n 运行时 + 语言 UI
admin-notification@skyroc/web-admin-notification站内通知中心
admin-runtime@skyroc/web-admin-runtime启动期副作用插件
admin-styles@skyroc/web-admin-styles全局 CSS 资产
admin-vite@skyroc/web-admin-viteVite 配置预设
admin/devtools@shell/devtools随 Admin Shell 分发的开发调试模块

详见 Web 端包总览。三个 ui/* 包的组件文档、实时 Demo 与 Props 表在独立的 Web UI 站点

packages/hooks、primitives —— 跨端共享

目录包名职责
hooks@skyroc/hooks跨端 React hooks(含 ./web
primitives/filed-form@skyroc/form类型安全表单 primitive

纯类型不单独成包:通用 TS 工具类型在 @skyroc/utils/type,三端组件词汇在 @skyroc/tailwind-plugin/ui。原先的 packages/shared/ 目录已随两个包并入而删除。

详见 跨端共享层@skyroc/hooks@skyroc/form

packages/native —— React Native 端

目录包名职责
native/ui@skyroc/native-uiReact Native / Expo 组件库

组件文档与 Expo Demo 在独立的 Native UI 站点。

internal —— 内部配置包

目录包名职责
tsconfig@skyroc/tsconfig共享 TS 编译配置
config@skyroc/config共享 vitest / oxlint 配置
uno-config@skyroc/uno-configUnoCSS 预设

详见 内部配置包

Last updated on