TurkNet / design-system

Design System with Storybook
MIT License
16 stars 2 forks source link

TurkNet Design System

Installation

Install the package in your project directory with:

npm install @turk.net/design-system

// or

yarn add @turk.net/design-system

Usage

import { Alert } from '@turk.net/design-system'

const SampleComponent = () => {
  return (
    <Alert severity="warning">
      This Alert Component, The severity property changes alert color.
    </Alert>
  )
}

Development

🚅 Quick start

  1. Install the dependencies.

    Navigate into your new site’s directory and install the necessary dependencies.

    # Navigate to the directory
    cd design-system/
    
    # Install the dependencies
    yarn
  2. Open the source code and start editing!

    
    yarn start
    
  3. Build storybook

    
    yarn build
    
  4. Build library

    
    yarn build-library
    

Learning Storybook

  1. Read our introductory tutorial over at Storybook tutorials.
  2. Learn how to transform your component libraries into design systems in our Design Systems for Developers tutorial.
  3. See our official documentation at Storybook.