Lorikeet Widget

This is the source for chat widget the Lorikeet platform.

The widget is split over two parts of the codebase currently. The first part is the widget itself, which is a minimal script that generates an iframe and initialisation configuration. The second part is the iframe itself found at apps/chat.

Depending on what you're trying to iterate on might change what you need to run.

import { Lorikeet } from '@lorikeetai/web-sdk'
// include the environment types correctly
declare global {
  interface Window {
    lorikeet: Lorikeet
  }
}

Development

To develop locally you'll need to have the iframe/chat instance running locally.

# at minimum you'll need to have the chat instance running
pnpm --filter @lorikeetai/chat dev

To have this running an actual conversation you'll need the support server running too.

# in root
docker compose up

Development of the widget init script

To start the development server, run:

# run the dev server that mounts the widget in a minimal local index.html
pnpm dev

To build the widget, run:

# this will make the widget available in the dist folder for usage in the web app
pnpm build

Production

To build the widget for production and release it, run:

pnpm run release

You will need to be logged in to gcloud to release the widget

gcloud auth login