mirror of
https://github.com/iflytek/skillhub.git
synced 2026-08-27 11:14:59 +00:00
docs: add Chinese README and language switcher
- Add README_zh.md with full Chinese translation - Add English | 中文 language switcher to README.md
This commit is contained in:
wowo-zZ
parent
9828c0a575
commit
a560bbcea3
2 changed files with 294 additions and 0 deletions
|
|
@ -15,6 +15,12 @@
|
|||
|
||||
</div>
|
||||
|
||||
<div align="center">
|
||||
|
||||
[English](./README.md) | [中文](./README_zh.md)
|
||||
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
SkillHub is a self-hosted platform that gives teams a private,
|
||||
|
|
|
|||
288
README_zh.md
Normal file
288
README_zh.md
Normal file
|
|
@ -0,0 +1,288 @@
|
|||
<div align="center">
|
||||
<img src="./skillhub-logo.svg" alt="SkillHub Logo" width="120" height="120" />
|
||||
<h1>SkillHub</h1>
|
||||
<p>企业级开源智能体技能注册中心 — 在组织内发布、发现和管理可复用的技能包</p>
|
||||
</div>
|
||||
|
||||
<div align="center">
|
||||
|
||||
[](https://zread.ai/iflytek/skillhub)
|
||||
[](./LICENSE)
|
||||
[](https://github.com/iflytek/skillhub/actions/workflows/publish-images.yml)
|
||||
[](https://ghcr.io/iflytek/skillhub)
|
||||
[](https://openjdk.org/projects/jdk/21/)
|
||||
[](https://react.dev)
|
||||
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
SkillHub 是一个自托管平台，为团队提供私有的、受治理的智能体技能共享空间。发布技能包，推送到命名空间，让其他人通过搜索发现或通过 CLI 安装。专为防火墙后的本地部署而构建，提供与公共注册中心相同的精致体验。
|
||||
|
||||
📖 **[完整文档 →](https://zread.ai/iflytek/skillhub)**
|
||||
|
||||
## 核心特性
|
||||
|
||||
- **自托管与私有化** — 部署在您自己的基础设施上。将专有技能保留在防火墙后，完全掌控数据主权。一条 `make dev-all` 命令即可在本地运行。
|
||||
- **发布与版本管理** — 上传智能体技能包，支持语义化版本控制、自定义标签（`beta`、`stable`）和自动 `latest` 跟踪。
|
||||
- **发现** — 全文搜索，支持按命名空间、下载量、评分和时间筛选。可见性规则确保用户只能看到其有权访问的内容。
|
||||
- **团队命名空间** — 在团队或全局范围下组织技能。每个命名空间拥有自己的成员、角色（Owner / Admin / Member）和发布策略。
|
||||
- **审核与治理** — 团队管理员在其命名空间内审核；平台管理员控制向全局范围的推广。治理操作记录审计日志以满足合规要求。
|
||||
- **社交功能** — 收藏技能、评分并跟踪下载量。围绕组织的最佳实践构建社区。
|
||||
- **账户合并** — 将多个 OAuth 身份和 API 令牌整合到单个用户账户下。
|
||||
- **API 令牌管理** — 为 CLI 和程序化访问生成作用域令牌，采用基于前缀的安全哈希。
|
||||
- **CLI 优先** — 原生 REST API，加上对现有 ClawHub 风格注册中心客户端的兼容层。原生 CLI API 是主要支持路径，协议兼容性持续扩展中。
|
||||
- **可插拔存储** — 开发环境使用本地文件系统，生产环境使用 S3 / MinIO。通过配置切换。
|
||||
- **国际化** — 使用 i18next 支持多语言。
|
||||
|
||||
## 快速开始
|
||||
|
||||
使用以下命令之一启动完整的本地环境：
|
||||
|
||||
官方镜像：
|
||||
```bash
|
||||
rm -rf /tmp/skillhub-runtime
|
||||
curl -fsSL https://raw.githubusercontent.com/iflytek/skillhub/main/scripts/runtime.sh | sh -s -- up
|
||||
```
|
||||
|
||||
阿里云镜像快捷方式：
|
||||
```bash
|
||||
rm -rf /tmp/skillhub-aliyun
|
||||
curl -fsSL https://imageless.oss-cn-beijing.aliyuncs.com/runtime.sh | sh -s -- up --home /tmp/skillhub-aliyun --aliyun --version edge
|
||||
```
|
||||
|
||||
如果部署遇到问题，请清除现有的运行时目录并重试。
|
||||
|
||||
### 前置要求
|
||||
|
||||
- Docker & Docker Compose
|
||||
|
||||
### 访问应用
|
||||
|
||||
- Web UI: http://localhost:3000
|
||||
- 后端 API: http://localhost:8080
|
||||
|
||||
### 默认账户
|
||||
|
||||
本地开发环境提供两个模拟用户：
|
||||
|
||||
- `local-user` — 普通用户，用于发布和命名空间操作
|
||||
- `local-admin` — 超级管理员，用于审核和管理流程
|
||||
|
||||
在本地开发中使用 `X-Mock-User-Id` 请求头切换用户。
|
||||
|
||||
### 停止服务
|
||||
|
||||
```bash
|
||||
# 使用官方镜像
|
||||
/tmp/skillhub-runtime/runtime.sh down
|
||||
|
||||
# 使用阿里云镜像
|
||||
/tmp/skillhub-aliyun/runtime.sh down
|
||||
```
|
||||
|
||||
## 开发
|
||||
|
||||
### 前置要求
|
||||
|
||||
- Java 21+
|
||||
- Node.js 20+
|
||||
- Docker & Docker Compose
|
||||
- Make
|
||||
|
||||
### 启动开发环境
|
||||
|
||||
```bash
|
||||
# 克隆仓库
|
||||
git clone https://github.com/iflytek/skillhub.git
|
||||
cd skillhub
|
||||
|
||||
# 启动完整的本地开发栈（后端 + 前端 + 依赖）
|
||||
make dev-all
|
||||
|
||||
# 或者分别启动
|
||||
make dev-backend # 仅后端
|
||||
make dev-web # 仅前端
|
||||
```
|
||||
|
||||
### 常用命令
|
||||
|
||||
```bash
|
||||
make help # 显示所有可用命令
|
||||
make test # 运行后端测试
|
||||
make typecheck-web # TypeScript 类型检查
|
||||
make build-web # 构建前端
|
||||
make generate-api # 重新生成 OpenAPI 类型
|
||||
./scripts/check-openapi-generated.sh # 验证 API 契约同步
|
||||
./scripts/smoke-test.sh http://localhost:8080 # 运行冒烟测试
|
||||
```
|
||||
|
||||
### 项目结构
|
||||
|
||||
```
|
||||
skillhub/
|
||||
├── server/ # 后端（Java/Spring Boot）
|
||||
│ ├── skillhub-app/ # 主应用程序
|
||||
│ ├── skillhub-domain/ # 核心业务逻辑
|
||||
│ ├── skillhub-auth/ # 认证授权
|
||||
│ ├── skillhub-search/ # 搜索功能
|
||||
│ ├── skillhub-storage/ # 存储层
|
||||
│ └── skillhub-infra/ # 基础设施
|
||||
├── web/ # 前端（React/TypeScript）
|
||||
├── docs/ # 文档
|
||||
├── scripts/ # 实用脚本
|
||||
├── deploy/ # 部署配置
|
||||
├── monitoring/ # Prometheus + Grafana
|
||||
├── Makefile # 常用任务
|
||||
└── docker-compose.yml # 本地开发栈
|
||||
```
|
||||
|
||||
## 部署
|
||||
|
||||
### 使用 Docker Compose
|
||||
|
||||
```bash
|
||||
# 使用官方镜像
|
||||
curl -fsSL https://raw.githubusercontent.com/iflytek/skillhub/main/scripts/runtime.sh | sh -s -- up
|
||||
|
||||
# 使用阿里云镜像
|
||||
curl -fsSL https://imageless.oss-cn-beijing.aliyuncs.com/runtime.sh | sh -s -- up --aliyun
|
||||
```
|
||||
|
||||
### 使用 Kubernetes
|
||||
|
||||
```bash
|
||||
# 应用 Kubernetes 清单
|
||||
kubectl apply -f deploy/k8s/
|
||||
|
||||
# 或使用 Helm（即将推出）
|
||||
helm install skillhub ./deploy/helm
|
||||
```
|
||||
|
||||
### 环境变量
|
||||
|
||||
关键配置选项：
|
||||
|
||||
```bash
|
||||
# 数据库
|
||||
SPRING_DATASOURCE_URL=jdbc:postgresql://localhost:5432/skillhub
|
||||
SPRING_DATASOURCE_USERNAME=skillhub
|
||||
SPRING_DATASOURCE_PASSWORD=skillhub
|
||||
|
||||
# Redis
|
||||
SPRING_DATA_REDIS_HOST=localhost
|
||||
SPRING_DATA_REDIS_PORT=6379
|
||||
|
||||
# 存储（S3/MinIO）
|
||||
STORAGE_TYPE=s3
|
||||
STORAGE_S3_ENDPOINT=http://localhost:9000
|
||||
STORAGE_S3_ACCESS_KEY=minioadmin
|
||||
STORAGE_S3_SECRET_KEY=minioadmin
|
||||
STORAGE_S3_BUCKET=skillhub
|
||||
|
||||
# 认证
|
||||
AUTH_JWT_SECRET=your-secret-key
|
||||
AUTH_SESSION_TIMEOUT=30m
|
||||
```
|
||||
|
||||
完整配置参考请查看 [`application.yml`](./server/skillhub-app/src/main/resources/application.yml)。
|
||||
|
||||
## 架构
|
||||
|
||||
SkillHub 采用清晰的分层架构：
|
||||
|
||||
- **表现层**：REST API（Spring Boot）+ React 前端
|
||||
- **应用层**：用例编排和 DTO 转换
|
||||
- **领域层**：核心业务逻辑和实体
|
||||
- **基础设施层**：数据库、存储、搜索
|
||||
|
||||
关键设计决策：
|
||||
|
||||
- **多模块 Maven 项目**：清晰的模块边界和依赖管理
|
||||
- **领域驱动设计**：丰富的领域模型和业务规则
|
||||
- **CQRS 模式**：读写分离以优化性能
|
||||
- **事件溯源**：审计日志和治理操作
|
||||
- **可插拔存储**：通过配置在本地/S3/MinIO 之间切换
|
||||
|
||||
详细架构文档请参阅 [`docs/`](./docs/) 目录。
|
||||
|
||||
## 技术栈
|
||||
|
||||
### 后端
|
||||
- **语言**：Java 21
|
||||
- **框架**：Spring Boot 3.2.3
|
||||
- **数据库**：PostgreSQL 16 + Flyway 迁移
|
||||
- **缓存**：Redis 7
|
||||
- **存储**：S3/MinIO
|
||||
- **搜索**：PostgreSQL 全文搜索
|
||||
|
||||
### 前端
|
||||
- **语言**：TypeScript
|
||||
- **框架**：React 19
|
||||
- **构建工具**：Vite
|
||||
- **路由**：TanStack Router
|
||||
- **数据获取**：TanStack Query
|
||||
- **样式**：Tailwind CSS + Radix UI
|
||||
- **API 客户端**：OpenAPI TypeScript（类型安全）
|
||||
- **国际化**：i18next
|
||||
|
||||
### 基础设施
|
||||
- **容器化**：Docker & Docker Compose
|
||||
- **监控**：Prometheus + Grafana
|
||||
- **部署**：Kubernetes 清单
|
||||
- **CI/CD**：GitHub Actions
|
||||
|
||||
## 路线图
|
||||
|
||||
- [x] 核心技能注册功能
|
||||
- [x] 命名空间和团队管理
|
||||
- [x] 审核和治理工作流
|
||||
- [x] 全文搜索和筛选
|
||||
- [x] 社交功能（收藏、评分、下载）
|
||||
- [x] API 令牌管理
|
||||
- [x] 账户合并
|
||||
- [x] 国际化支持
|
||||
- [ ] Helm Chart 部署
|
||||
- [ ] 高级搜索过滤器
|
||||
- [ ] 技能依赖管理
|
||||
- [ ] Webhook 集成
|
||||
- [ ] 审计日志导出
|
||||
- [ ] LDAP/SAML 集成
|
||||
|
||||
完整路线图请参阅 [`docs/10-delivery-roadmap.md`](./docs/10-delivery-roadmap.md)。
|
||||
|
||||
## 与智能体平台集成
|
||||
|
||||
SkillHub 设计为与各种智能体平台和框架无缝集成。
|
||||
|
||||
### [AstronClaw](https://agent.xfyun.cn/astron-claw)
|
||||
|
||||
[AstronClaw](https://agent.xfyun.cn/astron-claw) 是科大讯飞星火平台提供的技能市场。您可以将其连接到自托管的 SkillHub 注册中心，在组织内管理和分发私有技能，或在星火平台上浏览公开共享的技能。
|
||||
|
||||
### [astron-agent](https://github.com/iflytek/astron-agent)
|
||||
|
||||
[astron-agent](https://github.com/iflytek/astron-agent) 是科大讯飞星火智能体框架。存储在 SkillHub 中的技能可以被 astron-agent 直接引用和加载，实现从开发到生产的受治理、版本化的技能生命周期。
|
||||
|
||||
---
|
||||
|
||||
> 🌟 **展示与分享** — 您使用 SkillHub 构建了什么？我们很想听听！
|
||||
> 在 [**Discussions → Show and Tell**](https://github.com/iflytek/skillhub/discussions/categories/show-and-tell) 分类中分享您的用例、集成或部署故事。
|
||||
|
||||
## 贡献
|
||||
|
||||
欢迎贡献。请先开启 issue 讨论您想要更改的内容。
|
||||
|
||||
- 贡献指南：[`CONTRIBUTING.md`](./CONTRIBUTING.md)
|
||||
- 行为准则：[`CODE_OF_CONDUCT.md`](./CODE_OF_CONDUCT.md)
|
||||
|
||||
## 📞 支持
|
||||
|
||||
- 💬 **社区讨论**：[GitHub Discussions](https://github.com/iflytek/skillhub/discussions)
|
||||
- 🐛 **Bug 报告**：[Issues](https://github.com/iflytek/skillhub/issues)
|
||||
- 👥 **企业微信群**：
|
||||
|
||||
|
||||
|
||||
## 许可证
|
||||
|
||||
Apache License 2.0
|
||||
Loading…
Add table
Reference in a new issue