Cirro Client (TypeScript)

Packages:

• API client for Cirro @cirrobio/api-client

  

• SDK for Cirro @cirrobio/sdk

  

React Libraries:

• Core @cirrobio/react-core

  

• Authentication @cirrobio/react-auth

  

• Tool development @cirrobio/react-tool

  

Development

Any updates to the API or SDK should bump the version number for both.

To update the API client, bump the version in openapitools.json under npmVersion and run npm run apiCodeGen

To update the SDK, bump the version in packages/sdk/package.json under version.

You must have Java installed to use the openapi-generator-cli.

Getting Started

To run the example project (image-viewer) locally, follow these steps:

1. Install dependencies (from the root of the monorepo):

   yarn install

2. Build all packages (from the root):

   yarn build

3. Launch the example app (from the example directory):

   cd examples/image-viewer
   yarn dev

   This starts the Vite dev server (typically at http://localhost:8000/tools/image).