Installation

Squire ships a JavaScript SDK for web-based clients. It has no framework dependency, so it works with React, Angular, Vue or plain JavaScript.

Configure the npm registry

The SDK is published to a private npm registry. Add the registry and your token to the .npmrc file in your project, or create the file if it does not exist:

.npmrc


@squirehealth:registry=https://pkg.squire.eu/npm/
//pkg.squire.eu/npm/:_authToken=YOUR_TOKEN

Replace YOUR_TOKEN with the package repository token from the Portal.

Install the SDK

npm


npm install @squirehealth/sdk

pnpm


pnpm add @squirehealth/sdk

yarn


yarn add @squirehealth/sdk

The package includes TypeScript type definitions.

Next steps

Recording with the SDKInitialize the SDK and build your own recording interface.WidgetsMount a ready-made recording, microphone test or intake widget.