Skip to content

tetherto/m-sdk-ui-dev-kit

Repository files navigation

Mining SDK UI Development Kit

A developer-first toolkit providing pre-built components and seamless backend integration for building mining operations applications in days instead of weeks.

License

📋 Table of Contents


Overview

The Mining SDK UI Development Kit is a comprehensive toolkit providing:

  • 150-200+ production-tested components (foundation + domain-specific)
  • 87+ API integration hooks (RTK Query-based)
  • 70+ custom React hooks for common patterns
  • Complete state management (Redux Toolkit)
  • Modern tech stack (React 19, shadcn/ui, React Hook Form, Zod)
  • 5x faster forms compared to legacy solutions

Key Benefits

  • 🚀 10x faster development - Build dashboards in days, not weeks
  • 🎨 Consistent UX - Uniform design patterns across all applications
  • 🔌 Seamless integration - Type-safe API client with intelligent caching
  • 🎯 Battle-tested - Extracted from production Mining OS codebase
  • 📦 Zero CSS-in-JS runtime - Better performance, smaller bundles

Getting Started

Prerequisites

  • Node.js 20+ (LTS)
  • pnpm 9+ (package manager)

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

Quick Start

# Run all packages in dev mode
pnpm dev

# Run specific package
pnpm dev --filter @mining-sdk/components-foundation

# Build all packages
pnpm build

# Run tests
pnpm test

# Lint and typecheck
pnpm check

Documentation

  • Architecture - System architecture, package structure, and technology stack
  • Contributing - Contribution guidelines, development workflow, and coding standards

Examples


Support


License

Apache 2.0 - See LICENSE for details.


Acknowledgments

Built with contributions from the mining operations team.

About

No description, website, or topics provided.

Resources

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 5