Skip to content

Latest commit

 

History

History
48 lines (32 loc) · 2.59 KB

README.md

File metadata and controls

48 lines (32 loc) · 2.59 KB

Storybook for React

Build Status on CircleCI CodeFactor Known Vulnerabilities BCH compliance codecov
Storybook Slack Backers on Open Collective Sponsors on Open Collective


Storybook for React is a UI development environment for your React components. With it, you can visualize different states of your UI components and develop them interactively.

Storybook Screenshot

Storybook runs outside of your app. So you can develop UI components in isolation without worrying about app specific dependencies and requirements.

Getting Started

npm i -g @storybook/cli
cd my-react-app
getstorybook

For more information visit: storybook.js.org


Storybook also comes with a lot of addons and a great API to customize as you wish. You can also build a static version of your storybook and deploy it anywhere you want.

Here are some featured storybooks that you can reference to see how Storybook works:

Typescript

If you are using Typescript, make sure you have the type definitions installed via yarn add @types/node @types/react @types/storybook__react --dev.

Docs