Skip to content
This repository has been archived by the owner on Aug 13, 2021. It is now read-only.

Latest commit

 

History

History
29 lines (15 loc) · 1.1 KB

CONTRIBUTING.md

File metadata and controls

29 lines (15 loc) · 1.1 KB

Prerequisites

We use Storybook for testing things visually, and Docz for building a static documentation site.

Installation

Clone this repository and run npm install in your project folder to install the necessary dependencies.

Scripts

Building

npm run build bundles the library with Rollup & Bublé, so that you can then npm run publish it.

npm run build:watch continously builds the library while you work. This is useful if you npm link the repository when using it in other projects locally.

Storybook

npm run storybook:start starts Storybook on http://localhost:6001.

npm run storybook:build creates a static version of the Storybook in .storybook/dist.

Docz

npm run docs:start starts Docz on http://localhost:3000.

npm run docs:build builds a static Docz website in .docz/dist.

npm run docs:deploy pushes the static Docz website to the gh-pages branch, so that it's available at https://evercoder.github.io/uiuiui.