- Package
- Description
- @coze/api
- Coze API SDK
- @coze/realtime-api
- Realtime API SDK
- @coze/taro-api
- Taro Mini Program Coze API SDK
Specs
- PackageDescription
- @coze/apiCoze API SDK
- @coze/realtime-apiRealtime API SDK
- @coze/taro-apiTaro Mini Program Coze API SDK
- @coze/uniapp-apiUniApp Mini Program Coze API SDK
README
Monorepo of Coze Orz
English | 简体中文
📦 Packages
This monorepo contains the following packages:
| Package | Description | Version |
|---|---|---|
| @coze/api | Coze API SDK |  |
| @coze/realtime-api | Realtime API SDK |  |
| @coze/taro-api | Taro Mini Program Coze API SDK |  |
| @coze/uniapp-api | UniApp Mini Program Coze API SDK |  |
🎮 Examples
Find usage examples for each package in the examples directory:
- coze-js-node - Node.js Demo for @coze/api
- coze-js-web - React Web Demo for @coze/api, Preview
- coze-js-taro - Taro4 Mini Program Demo for @coze/taro-api
- coze-js-taro3 - Taro3 Mini Program Demo for @coze/taro-api
- coze-js-uniapp - UniApp(V3) Mini Program Demo for @coze/uniapp-api
- coze-js-uniapp-v2 - UniApp(V2) Mini Program Demo for @coze/api
- realtime-console - Full Console Demo for @coze/realtime-api, Preview
- realtime-call-up - Sample Call Up Demo for @coze/realtime-api
- realtime-quickstart-react - Quickstart React Demo for @coze/realtime-api
- realtime-quickstart-vue - Quickstart Vue Demo for @coze/realtime-api
- quickstart-oauth-server - Quickstart OAuth Server Demo for Coze SDK
- realtime-websocket - Websocket realtime Demo for @coze/api/ws-tools
- simult-extendsion - Simult interpretation Extension Demo for @coze/api/ws-tools
🚀 Getting Started
Prerequisites
- Node.js 18+ (LTS/Hydrogen recommended)
- pnpm 9.12.0
- Rush 5.140.0
Installation
- Install Node.js 18+
nvm install lts/hydrogen
nvm alias default lts/hydrogen # set default node version
nvm use lts/hydrogen- Clone the repository
git clone [email protected]:coze-dev/coze-js.git- Install required global dependencies
npm i -g [email protected] @microsoft/[email protected]- Install project dependencies
rush update- Build the project
rush buildAfter that, you can start to develop projects inside this repository.
Enjoy it!
🔨 Development
Each package in this monorepo can be developed and published independently. To start developing:
- Navigate to the package directory:
cd packages/<package-name>- Start development:
npm run start