Skip to content

uplift-initiative/client-js

Repository files navigation

UpliftAI Client Libraries

Monorepo containing client libraries for building real-time AI assistants with UpliftAI.

Packages

Getting Started

Installation

Install the package you need:

npm install @upliftai/assistants-react

Quick Example

import { UpliftAIRoom, useUpliftAIRoom } from '@upliftai/assistants-react';

function App({ token, wsUrl }) {
  return (
    <UpliftAIRoom
      token={token}
      serverUrl={wsUrl}
      connect={true}
      audio={true}
    >
      <YourAssistantUI />
    </UpliftAIRoom>
  );
}

Development

This monorepo uses pnpm for package management.

Setup

# Install pnpm if you haven't already
npm install -g pnpm

# Install dependencies
pnpm install

# Build all packages
pnpm build

# Run development mode
pnpm dev

Running Examples

# Navigate to an example
cd examples/basic-assistant

# Start the development server
pnpm dev

API Documentation

See the individual package READMEs for detailed API documentation:

License

MIT

About

Monorepo for JS Client NPM packages offered by Uplift AI

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published