English | ็ฎไฝไธญๆ
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 |  |
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
- 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
- Node.js 18+ (LTS/Hydrogen recommended)
- pnpm 9.12.0
- Rush 5.140.0
- 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 git@github.com:coze-dev/coze-js.git- Install required global dependencies
npm i -g pnpm@9.12.0 @microsoft/rush@5.140.0- Install project dependencies
rush update- Build the project
rush buildAfter that, you can start to develop projects inside this repository.
Enjoy it!
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
