Skip to content

README.md

Latest commit

 

History

History
84 lines (61 loc) · 2.38 KB

README.md

File metadata and controls

84 lines (61 loc) · 2.38 KB
Raw

GD Design System

Nx monorepo containing the GridKit design system packages.

Packages

Package Version Description
gd-design-library npm GridKit React component library + design tokens
gd-form-configurator npm JSON-Schema form engine (AJV + Zustand)
gd-form-configurator-react npm React bindings for gd-form-configurator

Quick start

Install the primary package:

npm install gd-design-library

Import components and styles:

import { Button, ThemeProvider } from 'gd-design-library';
import 'gd-design-library/styles.css';

export default function App() {
  return (
    <ThemeProvider>
      <Button variant="primary">Click me</Button>
    </ThemeProvider>
  );
}

See the Storybook for interactive component examples and full API documentation.

Setup

# Node >= 22.17.0 required
npm install

Development

npm run storybook          # Storybook at http://localhost:6006
npm test                   # gd-design-library unit tests
npm run test:form-configurator   # form-configurator tests
npm run type-check         # TypeScript check
npm run lint               # ESLint

Build

npm run build:ui                # Build gd-design-library (ESM + CJS + types)
npm run build:form-configurator # Build both form-configurator packages
npm run build-storybook         # Build static Storybook

Verification (gd-design-library)

npm run verify:ui:full     # Full 10-phase dist verification + Verdaccio smoke test
npm run verify:ui:ci       # CI gate (non-zero exit on failure)

Publishing

# gd-design-library
npm run build:ui && npm run publish:ui

# form-configurator — via GitHub Actions (publish-form-configurator.yaml) or:
npm run build:form-configurator && npm run publish:form-configurator

Scaffold a new component

npm run crc ComponentName