@spaceback/flightdeck

Browser SDK for building Flightdeck-powered experiences.

This directory is a self-contained package; it does not share a lockfile or node_modules with the rest of the Amplify repo. Run all commands from packages/flightdeck/.

Developing

cd packages/flightdeck
yarn install
yarn build       # builds the package
yarn typecheck   # type-checks the package

Install

yarn add @spaceback/flightdeck

Usage

import {
  createFlightdeckClient,
  FlightdeckProvider,
  useFlightdeckDispatch,
  useFlightdeckState,
} from '@spaceback/flightdeck';

const client = createFlightdeckClient({
  cableUrl: 'wss://your-flightdeck-host/cable',
  contextSlug: 'your-context',
});

export function App({ children }: { children: React.ReactNode }) {
  return <FlightdeckProvider client={client}>{children}</FlightdeckProvider>;
}

Publishing

Initial 0.0.1 publish:

cd packages/flightdeck
yarn build
npm publish --access public

Future version bumps are manual for now. See scripts/publish.sh.