Docs

快速开始

配置 Scopify 本地环境并启动需要的应用。

环境要求

  • pnpm 12.x(corepack enable 后按 packageManager 自动匹配)
  • Bun 1.3.11 或更高版本(运行 TypeScript 脚本与 bun test)
  • Node.js 20 或更高版本

建议使用支持现代 Node.js 与 Bun 的 Windows 开发环境。首次克隆时需要递归获取后端子模块:

git clone --recurse-submodules https://github.com/MT-SUPER-POWER/Scopify.git
cd Scopify

已经克隆仓库时,可以单独补齐后端:

git submodule update --init --recursive repo/backend/api-enhanced

安装依赖

pnpm install

启动方式

pnpm run dev          # Web + Electron
pnpm run dev:web      # 仅 Web
pnpm run dev:desktop  # 仅 Electron
pnpm run dev:full     # Web + Electron + 后端
pnpm run dev:docs     # 文档站

Web 与 Electron 的应用源码位于 repo/frontend/apps/,共享包位于 repo/frontend/packages/;后端位于 repo/backend/api-enhanced/,保持独立部署。

构建与打包

pnpm run build:web      # 构建 Web
pnpm run build:desktop  # 构建 Renderer 与 Electron 主进程
pnpm run build:win      # 生成 Windows 安装包
pnpm run build:mac      # 生成 macOS 安装包

生产 Web 使用 pnpm run build:web 构建,并从 repo/frontend/apps/web 启动 Next.js 服务。Electron 的静态 Renderer 是独立构建目标,不用于普通 Web 部署。

开始阅读

  • 如果你准备修改产品能力,先阅读系统架构。
  • 如果你准备使用共享组件,进入 UI Library。
  • 如果你准备联调后端,进入 OpenAPI。

本页内容