comp-hub

Appearance

快速上手 ​

本章节将引导您快速安装并开始使用 comp-hub 平台，帮助您高效地管理和复用组件资源。

平台支持 ​

目前 comp-hub 支持以下前端框架：

  • ✅ Vue 2
  • ✅ Vue 3
  • ❌ React（暂不支持）

安装 comp-hub ​

在您的项目中使用 npm 安装 comp-hub：

sh
npm install comp-hub@latest -D

运行 comp-hub 客户端 ​

安装完成后，通过以下命令启动 comp-hub 客户端：

sh
npx comphub

启动成功后，终端会显示访问地址：

http://localhost:3000

打开您的浏览器，访问上述地址即可进入 comp-hub 平台界面。

配置文件说明 ​

comphub.json ​

在项目根目录创建 comphub.json 文件，用于自定义 comp-hub 客户端的行为。以下是常用配置项：

json
{
  "port": 3000,
  "srcPath": "/src"
}

配置项说明 ​

  • port：

    • 类型：Number
    • 默认值：3000
    • 描述：指定 comp-hub 客户端运行的端口号

  • srcPath：

    • 类型：String
    • 默认值：项目根目录
    • 推荐值："/src"
    • 描述：指定组件代码所在的基础目录
    • 影响范围：该配置将直接影响组件上传和下载时可选择的目录范围，限定在指定目录及其子目录内