Skip to content

Files

Latest commit

 

History

History
100 lines (67 loc) · 2.92 KB

README.zh-CN.md

File metadata and controls

100 lines (67 loc) · 2.92 KB

Coze Orz Monorepo

codecov ci

English | 简体中文

📦 包列表

本 monorepo 包含以下包:

包名 描述 版本
@coze/api Coze API SDK npm
@coze/realtime-api 实时语音 SDK npm
@coze/taro-api 支持 Taro 小程序的 Coze API SDK npm

🎮 示例

examples 目录中查找每个包的使用示例:

🚀 快速开始

前置要求

  • Node.js 18+ (推荐 LTS/Hydrogen)
  • pnpm 9.12.0
  • Rush 5.140.0

安装步骤

  1. 安装 Node.js 18+
nvm install lts/hydrogen
nvm alias default lts/hydrogen # 设置默认 node 版本
nvm use lts/hydrogen
  1. 克隆仓库
git clone git@github.com:coze-dev/coze-js.git
  1. 安装必需的全局依赖
npm i -g pnpm@9.12.0 @microsoft/rush@5.140.0
  1. 安装项目依赖
rush update
  1. 构建项目
rush build

完成上述步骤后,你就可以开始在这个仓库中进行开发了。

开始享受开发吧!

🔨 开发

此 monorepo 中的每个包都可以独立开发和发布。开始开发:

  1. 进入包目录:
cd packages/<package-name>
  1. 启动开发:
npm run start

📖 文档

📄 许可证

MIT