comp-hub

所见即所得的组件预览与共享平台，让组件的使用变得更加简单高效。

📖 项目简介

comp-hub 是一个专为前端开发者设计的组件管理平台，致力于解决组件复用、文档缺失、标准化程度低等开发痛点。通过提供实时预览、依赖管理、版本控制等功能，让组件的共享和使用变得更加简单高效。

🚀 核心功能

• 实时预览与依赖管理：组件在线实时预览，自动匹配依赖版本，确保下载后所见即所得
• 轻量组件架构：组件仅包含最小运行单元，运行时无缝集成到现有工程环境
• 简易上传流程：三步完成组件发布，支持预览配置、文档编写与版本管理
• 完善文档支持：支持标准 Markdown 文档，自动生成目录结构
• 版本管理系统：支持语义化版本规范，多版本并存与切换
• 跨项目复用：标准化的组件结构确保在不同项目间的高兼容性与可移植性

📦 平台支持

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

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

💻 安装与使用

安装

npm install comp-hub@latest -g

运行

npx comphub

启动成功后，访问以下地址进入平台：

http://localhost:3000

配置文件

在项目根目录创建 comphub.json 文件自定义客户端行为：

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

配置项说明：

• port：指定运行端口（默认：3000）
• srcPath：指定组件代码所在基础目录（推荐："/src"）

📚 详细文档

完整的使用指南和API文档请访问我们的官方文档：

comp-hub 官方文档

🔧 组件规范

• 组件必须以文件夹形式上传，文件夹名称即为组件名称
• 组件文件夹下必须包含 index.vue 作为入口文件
• 建议提供 README.md 详细描述组件功能和使用方法
• 支持 comp.json 文件配置组件元数据

🎯 版本管理

comp-hub 支持语义化版本规范：

• X.Y.Z 格式（如 1.2.3）
• X：主版本，不兼容的API变更
• Y：次版本，向下兼容的功能性新增
• Z：修订号，向下兼容的问题修正

🤝 贡献指南

欢迎贡献代码或提出建议！请参考我们的贡献指南了解更多信息。

👥 社区支持

加入我们的QQ群获取更多帮助和交流：

官方QQ群: 1049663501

📝 许可证

MIT License