UI Kit Components for GitKraken Desktop

This repository contains the source code for GitKraken Desktop's Celestial UI Kit, a collection of reusable components designed to streamline development and ensure consistent user experiences. Built with modern web technologies, this kit provides a robust foundation for building high-quality interfaces in our flagship product.

We leverage TypeScript for type safety, React 19 for a performant UI, and Vite for rapid development. Comprehensive testing is achieved with Vitest and React Testing Library, including tools for testing custom hooks. Code quality is maintained through ESLint, while Storybook provides interactive component documentation and Playwright ensures end-to-end testing.

Installation and Usage

The @gitkraken/gk-ui-kit library is distributed as a private npm package. To use it in your React projects, you'll need to install it via yarn (preferably), npm or pnpm.

Prerequisites:

• This library requires Node.js version 20+.
• Ensure you have a valid .npmrc file configured with the necessary credentials to access our private npm registry.

Installation:

yarn install @gitkraken/gk-ui-kit

Usage:

Once installed, you can import and use the components directly in your React code:

import { Button } from '@gitkraken/gk-ui-kit';

function MyComponent() {
  return <Button>Click Me</Button>;
}

Refer to the Storybook documentation for a complete list of available components and their usage guidelines.

Contributing to the UI Kit

For all development-specific guidelines and contribution instructions, please refer to the CONTRIBUTING.md file. This document provides detailed information on setting up your development environment, coding standards, submitting pull requests, and more.

Take me there!

© GitKraken 2025