Skip to content

huntye1/coze-js-fork

 
 

Repository files navigation

Monorepo of Coze Orz

codecov ci

📦 Packages

This monorepo contains the following packages:

Package Description Version
@coze/api Coze API npm
@coze/realtime-api Realtime API npm

🎮 Examples

Find usage examples for each package in the examples directory:

🚀 Getting Started

Prerequisites

  • Node.js 18+ (LTS/Hydrogen recommended)
  • pnpm 9.12.0
  • Rush 5.14.0

Installation

  1. Install Node.js 18+
nvm install lts/hydrogen
nvm alias default lts/hydrogen # set default node version
nvm use lts/hydrogen
  1. Clone the repository
git clone git@github.com:coze-dev/coze-js.git
  1. Install required global dependencies
npm i -g pnpm@9.12.0 @microsoft/rush@5.14.0
  1. Install project dependencies
rush update

After 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:

  1. Navigate to the package directory:
cd packages/<package-name>
  1. Start development:
npm run start

📖 Documentation

📄 License

MIT

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 91.0%
  • JavaScript 8.2%
  • Shell 0.8%