Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
80 changes: 40 additions & 40 deletions ARCHITECTURE.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,14 +37,14 @@ graph TB
```
miningos-ui-kit/
├── packages/
│ ├── core/ # @mdk/core - Types, constants, utilities
│ ├── hooks/ # @mdk/hooks - 70+ custom React hooks
│ ├── state/ # @mdk/state - Redux slices
│ ├── api-client/ # @mdk/api-client - RTK Query endpoints
│ ├── components-foundation/ # @mdk/components-foundation - Generic components
│ ├── components-domain/ # @mdk/components-domain - Mining-specific
│ ├── features/ # @mdk/features - Complete feature modules
│ └── theme/ # @mdk/theme - Design system
│ ├── core/ # @mining-sdk/core - Types, constants, utilities
│ ├── hooks/ # @mining-sdk/hooks - 70+ custom React hooks
│ ├── state/ # @mining-sdk/state - Redux slices
│ ├── api-client/ # @mining-sdk/api-client - RTK Query endpoints
│ ├── components-foundation/ # @mining-sdk/components-foundation - Generic components
│ ├── components-domain/ # @mining-sdk/components-domain - Mining-specific
│ ├── features/ # @mining-sdk/features - Complete feature modules
│ └── theme/ # @mining-sdk/theme - Design system
├── apps/
│ ├── docs/ # Documentation site
│ ├── playground/ # Component playground
Expand All @@ -59,14 +59,14 @@ miningos-ui-kit/
```mermaid
graph LR
App[Your Application]
Features[@mdk/features]
Domain[@mdk/components-domain]
Foundation[@mdk/components-foundation]
API[@mdk/api-client]
State[@mdk/state]
Hooks[@mdk/hooks]
Core[@mdk/core]
Theme[@mdk/theme]
Features[@mining-sdk/features]
Domain[@mining-sdk/components-domain]
Foundation[@mining-sdk/components-foundation]
API[@mining-sdk/api-client]
State[@mining-sdk/state]
Hooks[@mining-sdk/hooks]
Core[@mining-sdk/core]
Theme[@mining-sdk/theme]

App --> Features
App --> Domain
Expand All @@ -92,7 +92,7 @@ graph LR

## Core Packages

### `@mdk/core`
### `@mining-sdk/core`

**Purpose**: Shared types, constants, and utilities

Expand All @@ -104,12 +104,12 @@ graph LR

**Usage**:
```typescript
import { DeviceType, formatHashrate, isValidMiner } from "@mdk/core";
import { DeviceType, formatHashrate, isValidMiner } from "@mining-sdk/core";
```

---

### `@mdk/components-foundation`
### `@mining-sdk/components-foundation`

**Purpose**: Generic, reusable UI components

Expand All @@ -122,7 +122,7 @@ import { DeviceType, formatHashrate, isValidMiner } from "@mdk/core";

**Usage**:
```typescript
import { Button, DataTable, LineChart } from "@mdk/components-foundation";
import { Button, DataTable, LineChart } from "@mining-sdk/components-foundation";
```

**Key Features**:
Expand All @@ -133,7 +133,7 @@ import { Button, DataTable, LineChart } from "@mdk/components-foundation";

---

### `@mdk/components-domain`
### `@mining-sdk/components-domain`

**Purpose**: Mining-specific components

Expand All @@ -146,12 +146,12 @@ import { Button, DataTable, LineChart } from "@mdk/components-foundation";

**Usage**:
```typescript
import { MinerCard, HashRateChart, DeviceExplorer } from "@mdk/components-domain";
import { MinerCard, HashRateChart, DeviceExplorer } from "@mining-sdk/components-domain";
```

---

### `@mdk/features`
### `@mining-sdk/features`

**Purpose**: Complete, ready-to-use feature modules

Expand All @@ -166,7 +166,7 @@ import { MinerCard, HashRateChart, DeviceExplorer } from "@mdk/components-domain

**Usage**:
```typescript
import { DashboardModule, DeviceManagementModule } from "@mdk/features";
import { DashboardModule, DeviceManagementModule } from "@mining-sdk/features";

function App() {
return (
Expand All @@ -181,7 +181,7 @@ function App() {

---

### `@mdk/api-client`
### `@mining-sdk/api-client`

**Purpose**: RTK Query-based API client with 87+ hooks

Expand All @@ -196,7 +196,7 @@ function App() {

**Usage**:
```typescript
import { useGetListThingsQuery, useGetOperationsHashrateQuery } from "@mdk/api-client";
import { useGetListThingsQuery, useGetOperationsHashrateQuery } from "@mining-sdk/api-client";

function DeviceList() {
const { data, isLoading } = useGetListThingsQuery({ siteId: "site-1" });
Expand All @@ -208,7 +208,7 @@ function DeviceList() {

---

### `@mdk/hooks`
### `@mining-sdk/hooks`

**Purpose**: 70+ custom React hooks

Expand All @@ -221,7 +221,7 @@ function DeviceList() {

**Usage**:
```typescript
import { useDebounce, useLocalStorage, useRealTimeMetrics } from "@mdk/hooks";
import { useDebounce, useLocalStorage, useRealTimeMetrics } from "@mining-sdk/hooks";

function SearchBar() {
const [search, setSearch] = useState("");
Expand All @@ -234,7 +234,7 @@ function SearchBar() {

---

### `@mdk/state`
### `@mining-sdk/state`

**Purpose**: Redux Toolkit state management

Expand All @@ -248,7 +248,7 @@ function SearchBar() {

**Usage**:
```typescript
import { useAppSelector, useAppDispatch, selectSelectedDevices } from "@mdk/state";
import { useAppSelector, useAppDispatch, selectSelectedDevices } from "@mining-sdk/state";

function DeviceActions() {
const dispatch = useAppDispatch();
Expand All @@ -260,7 +260,7 @@ function DeviceActions() {

---

### `@mdk/theme`
### `@mining-sdk/theme`

**Purpose**: Design system and theming

Expand All @@ -273,7 +273,7 @@ function DeviceActions() {

**Usage**:
```typescript
import { ThemeProvider, useTheme } from "@mdk/theme";
import { ThemeProvider, useTheme } from "@mining-sdk/theme";

function App() {
return (
Expand Down Expand Up @@ -359,14 +359,14 @@ function ThemeToggle() {

| Package | Target Size (gzipped) | Current Size |
|---------|----------------------|--------------|
| `@mdk/core` | < 50KB | TBD |
| `@mdk/components-foundation` | < 150KB | TBD |
| `@mdk/components-domain` | < 200KB | TBD |
| `@mdk/features` | < 250KB | TBD |
| `@mdk/api-client` | < 100KB | TBD |
| `@mdk/hooks` | < 50KB | TBD |
| `@mdk/state` | < 50KB | TBD |
| `@mdk/theme` | < 30KB | TBD |
| `@mining-sdk/core` | < 50KB | TBD |
| `@mining-sdk/components-foundation` | < 150KB | TBD |
| `@mining-sdk/components-domain` | < 200KB | TBD |
| `@mining-sdk/features` | < 250KB | TBD |
| `@mining-sdk/api-client` | < 100KB | TBD |
| `@mining-sdk/hooks` | < 50KB | TBD |
| `@mining-sdk/state` | < 50KB | TBD |
| `@mining-sdk/theme` | < 30KB | TBD |

**Total**: < 500KB (vs. 700KB legacy)

Expand Down
10 changes: 5 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,11 +61,11 @@ chore(deps): update dependencies
```bash
# Development
pnpm dev # Run all packages in dev mode
pnpm dev --filter @mdk/core # Run specific package
pnpm dev --filter @mining-sdk/core # Run specific package

# Building
pnpm build # Build all packages
pnpm build --filter @mdk/* # Build specific packages
pnpm build --filter @mining-sdk/* # Build specific packages

# Testing
pnpm test # Run all tests
Expand All @@ -88,8 +88,8 @@ pnpm clean # Remove all build artifacts

```bash
# From root (recommended)
pnpm add react --filter @mdk/components-foundation
pnpm add -D vitest --filter @mdk/components-foundation
pnpm add react --filter @mining-sdk/components-foundation
pnpm add -D vitest --filter @mining-sdk/components-foundation

# Or cd into package
cd packages/components-foundation
Expand Down Expand Up @@ -117,7 +117,7 @@ cd packages/my-package

```json
{
"name": "@mdk/my-package",
"name": "@mining-sdk/my-package",
"version": "1.0.0",
"type": "module",
"main": "./dist/index.js",
Expand Down
7 changes: 3 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# MDK UI Development Kit
# 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.

Expand All @@ -17,7 +17,7 @@

## Overview

The **MDK UI Development Kit** is a comprehensive toolkit providing:
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)
Expand Down Expand Up @@ -64,7 +64,7 @@ pnpm build
pnpm dev

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

# Build all packages
pnpm build
Expand All @@ -82,7 +82,6 @@ pnpm check

- **[Architecture](ARCHITECTURE.md)** - System architecture, package structure, and technology stack
- **[Contributing](CONTRIBUTING.md)** - Contribution guidelines, development workflow, and coding standards
- **API Documentation**: [docs.mdk.io]() (TBD)

---

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "mdk-ui",
"name": "mining-sdk-ui",
"version": "0.0.0",
"private": true,
"packageManager": "pnpm@10.5.0",
Expand Down