演示

安装

安装 @quan-erp/cli，用 quan-erp new-project 脚手架项目，启动 base 栈，再构建并注册插件。

1. 环境要求（Prerequisites）

创建项目前请先安装以下工具。CLI 与插件构建需要 Node.js；base 栈需要 Docker。

要求说明安装
Node.js 18+建议 20+ LTS — 用于 @quan-erp/cli 与插件 npmInstall →
Docker Engine + Compose v2运行 Postgres、Redis、backend、frontendInstall →
支持系统macOS、Linux，或 Windows + Docker Desktop / WSL2—
磁盘与内存为镜像与卷预留空间；本地 compose 建议约 4 GB RAM—

2. 安装 CLI

官方 CLI 发布为 @quan-erp/cli。全局安装后使用 quan-erp（别名：quark-erp、erp）。

SHTerminal
npm i -g @quan-erp/cli quan-erp help
@quan-erp/cli on npm →

3. 创建项目

在空目录中运行 quan-erp new-project 脚手架完整工作区。CLI 会拉取官方模板（https://github.com/TheParadance/quan-erp-node-template）。

  • 在空目录中运行 new-project
  • plugins/ — 插件源码（参考 sample-es）
  • base/ — docker-compose
  • .agents/ — AI 辅助开发 skills & rules
TSTerminal
mkdir my-quan-erp && cd my-quan-erp quan-erp new-project

4. 启动 base

首次启动前，在 base/docker-compose.yaml 的 backend environment 中设置 Firebase FCM（本地/开发可用 FIREBASE_CONFIG: ''；需要推送时再填入单行 service-account JSON）。然后在项目根目录启动本地 base Docker 栈。

YAMLbase/docker-compose.yaml (backend environment)
FIREBASE_CONFIG: ''
TSTerminal
quan-erp base:dev

5. 配置插件

参考 plugins/sample-es，或用 quan-erp new 脚手架。metadata.name 必须与文件夹名一致。

6. 使用 CLI 构建 / watch

在项目根目录执行 watch，产物会同步到 base/available-plugins/。

TSTerminal
quan-erp watch sample-es quan-erp build:prod sample-es

7. 本地库注册 module

仅在 local/dev Postgres 插入 module 行，切勿对 UAT/生产执行。

下一步

  • 阅读目录结构与 CLI
  • 在 ERP UI 中安装插件
  • 继续后端 / 前端 Doc