Skip to content

Latest commit

 

History

History
33 lines (25 loc) · 955 Bytes

README.md

File metadata and controls

33 lines (25 loc) · 955 Bytes
Raw

UXPin Storybook Deployer

This is a simple CLI tool allows you to push your Storybook on UXPin.

What is UXPin storybook integration?

UXPin_Storybook_integration

With UXPin storybook integration, you can use Storybook Component to design and prototype on Editor.

Requirements

  1. Auth token from UXPin
  2. Static storybook assets

Usage

  1. Install package as a dev dependencies
yarn add -D @uxpin/storybook-deployer
  1. Deploy to UXPin
npx uxpin-storybook-deployer -s path/to/storybook/ -t TOKEN

Available options

$ npx uxpin-storybook-deployer --help

Options:
  -s --source <path>  path to directory where storybook build locates (default: "storybook-static")
  -t --token <token>  auth token for the library.
  -h, --help          display help for command