@buildkite/react-flappy-kite

A game to play from the build page while you wait for your build to finish. Also integrates with our build statuses so you can keep an eye on your build.

NOTE: Not yet published to npm as we are still waiting to get the @buildkite handle on npm.

Installation

npm install @buildkite/react-flappy-kite

Usage

import { FlappyKite } from '@buildkite/react-flappy-kite';

function BuildPage() {
  const [isGameOpen, setIsGameOpen] = useState(false);
  const buildStatus = 'running'; // or any other Buildkite build status

  return (
    <div>
      <button onClick={() => setIsGameOpen(true)}>
        🪁 Launch Game
      </button>
      
      <FlappyKite 
        buildStatus={buildStatus}
        isOpen={isGameOpen}
        onClose={() => setIsGameOpen(false)}
      />
    </div>
  );
}

Props

| Prop | Type | Description | |------|------|-------------| | buildStatus | string | Current build status from Buildkite (e.g., 'running', 'failed', 'passed') | | isOpen | boolean | Controls whether the game modal is open | | onClose | () => void | Callback function called when the modal is closed |

Development

# Install dependencies
npm install

# Run tests
npm test

# Build the package
npm run build

# Type check
npm run typecheck

# Lint
npm run lint