UNPKG

1.86 kBMarkdownView Raw
1# React Storybook [![Build Status](https://travis-ci.org/kadirahq/react-storybook.svg?branch=master)](https://travis-ci.org/kadirahq/react-storybook) [![npm version](https://badge.fury.io/js/%40kadira%2Fstorybook.svg)](https://badge.fury.io/js/%40kadira%2Fstorybook) [![Storybook Slack](https://storybooks-slackin.herokuapp.com/badge.svg)](https://storybooks-slackin.herokuapp.com/)
2
3React Storybook is a UI development environment for your React components. With it, you can visualize different states of your UI components and develop them interactively.
4
5![React Storybook Screenshot](docs/demo.gif)
6
7React Storybook runs outside of your app. So you can develop UI components in isolation without worrying about app specific dependencies and requirements.
8
9## Getting Started
10
11```js
12npm i -g getstorybook
13cd my-react-app
14getstorybook
15```
16
17For more information visit: https://getstorybook.io
18
19---
20
21React Storybook also comes with a lot of [addons](https://getstorybook.io/docs/addons/introduction) and a great API to customize as you wish. You can also build a [static version](https://getstorybook.io/docs/basics/exporting-storybook) of your storybook and deploy it anywhere you want.
22
23Here are some featured storybooks that you can reference to see how Storybook works:
24
25 * [React Button](http://kadira-samples.github.io/react-button) - [source](https://github.com/kadira-samples/react-button)
26 * [Demo of React Dates](http://airbnb.io/react-dates/) - [source](https://github.com/airbnb/react-dates)
27 * [Demo of React Native Web](http://necolas.github.io/react-native-web/storybook/) - [source](https://github.com/necolas/react-native-web)
28
29## Docs
30
31* [Basics](https://getstorybook.io/docs/basics/introduction)
32* [Configurations](https://getstorybook.io/docs/configurations/default-config)
33* [Addons](https://getstorybook.io/docs/addons/introduction)