MDK Logo

MDK UI Kit

React component library for building Bitcoin mining interfaces

MDK UI Kit

The MDK UI Kit is a React-based component library that provides production-ready UI components for Bitcoin mining applications.

Prerequisites

  • React 18+
  • Node.js 20+
  • pnpm 10+

Packages

PackageDescription
@mdk/coreBase UI components (buttons, inputs, tables, etc.)
@mdk/foundationDomain-specific components, hooks, and constants

Installation

# Clone the repository
git clone https://github.com/tetherto/miningos-ui-kit.git
cd miningos-ui-kit

# Install dependencies
pnpm install

# Build all packages
pnpm build

Then add to your app's package.json:

{
  "dependencies": {
    "@mdk/foundation": "workspace:*"
  }
}

This also installs @mdk/core as a dependency. For core-only usage, see @mdk/core.

Quick start

import { SettingsDashboard } from '@mdk/foundation'

export function App() {
  return (
    <SettingsDashboard
      headerControlsProps={{ /* ... */ }}
      rbacControlProps={{ /* ... */ }}
    />
  )
}

For a complete walkthrough from installation to first component, see the Get started guide.

On this page