Skip to content

Latest commit

 

History

History
77 lines (52 loc) · 2.26 KB

README.md

File metadata and controls

77 lines (52 loc) · 2.26 KB
Raw

KustomzDesign

Storybook design system

TypeScript Storybook tested with jest lerna

Overview

Getting Started
Usage
Built With
Contributing

Getting Started

This project is a Storybook design system built with React. Storybook is a development environment and documentation tool for UI components that allows developers to build and test components independently, as well as showcase them interactively in an isolated environment.

For more information about building design systems with Storybook, visit Design Systems for Developers from the Learn Storybook docs.

Usage

Development Environment

To start the Storybook application and the KAPI dev server, run the following command from the root of the repository:

yarn dev:store-ui

Storybook will be available at http://localhost:3000, and the API at http://localhost:8080.

Storybook Only

To start only the Storybook application:

yarn dev:ui

from the root of the repository, or

yarn dev

from this directory.

Installation

  1. Add "@flex-development/kustomzdesign": "*" to package dependencies

    This package isn't published, so it can only be installed within this repo.

  2. Run yarn from the root of the repository to re-install project dependencies

Built With

  • React - JavaScript library for building user interfaces
  • Storybook - UI development and documentation tool
  • TypeScript - Typed JavaScript
  • Vercel - Hosting platform for static sites and serverless functions