Name: storybook
Owner: Storybook
Description: Interactive UI component dev & test: React, React Native, Vue, Angular
Created: 2016-03-18 04:23:44.0
Updated: 2018-01-19 01:07:41.0
Pushed: 2018-01-18 22:16:58.0
Homepage: https://storybook.js.org
Size: 74493
Language: JavaScript
GitHub Committers
User | Most Recent Commit | # Commits |
---|
Other Committers
User | Most Recent Commit | # Commits |
---|
Storybook is a development environment for UI components. It allows you to browse a component library, view the different states of each component, and interactively develop and test components.
Storybook runs outside of your app. This allows you to develop UI components in isolation, which can improve component reuse, testability, and development speed. You can build quickly without having to worry about application-specific dependencies.
Here are some featured examples that you can reference to see how Storybook works: https://storybook.js.org/examples/
Storybook comes with a lot of addons for component design, documentation, testing, interactivity, and so on. Storybook's easy-to-use API makes it easy to configure and extend in various ways. It has even been extended to support React Native development for mobile.
First install storybook:
i -g @storybook/cli
y-react-app
torybook
The -g
global install is used to run our cli tool in your project directory to generate templates for your existing projects. To avoid the global install and start your project manually, take a look at our Slow Start Guide.
Once it's installed, you can npm run storybook
and it will run the development server on your local machine, and give you a URL to browse some sample stories.
Storybook v2.x migration note: If you're using Storybook v2.x and want to shift to 3.x version the easiest way is:
i -g @storybook/cli
y-storybook-v2-app
torybook
It runs a codemod to update all package names. Read all migration details in our Migration Guide
For full documentation on using Storybook visit: storybook.js.org
For additional help, join us in our Slack
We welcome contributions to Storybook!
yarn bootstrap
Installs package dependencies and links packages together - using lerna
yarn run publish
Push a release to git and npm will ask for version in interactive mode - using lerna.
yarn lint
boolean check if code conforms to linting rules - uses remark & eslint
yarn lint:js
- will check js
yarn lint:md
- will check markdown + code samples
yarn lint:js --fix
- will automatically fix js
yarn test
boolean check if unit tests all pass - uses jest
yarn test:watch
- will run tests in watch-modeSupport us with a monthly donation and help us continue our activities. [Become a backer]
Become a sponsor and get your logo on our README on Github with a link to your site. [Become a sponsor]