storybooks/storybook-package

Name: storybook-package

Owner: Storybook

Description: https://www.npmjs.com/package/storybook

Created: 2017-09-13 13:29:00.0

Updated: 2017-12-17 15:16:08.0

Pushed: 2017-09-15 17:24:33.0

Homepage: null

Size: 91

Language: JavaScript

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

Storybook (CLI)

---

This package provides a CLI for adding Storybook to your project.

The quickest way to add Storybook to your project is to run this package via npx:

our-project-folder
storybook

That's all you've to do.

If you don't use npx install this CLI globally.

i -g storybook

Then go to your project's folder and run:

ybook

---

After that run Storybook by

run storybook

or

 storybook

For more information visit: storybook.js.org

---

Yarn support

It also supports yarn. If you have installed yarn in your system, it'll detect it and use yarn instead of npm.

If you don't want to use yarn always you can use the --use-npm option like this:

ybook --use-npm

---

Flow support

It also supports flow files. By default, jscodeshift, the tool used to transform the source files, uses babel to read the files. To be able to transform any flow annotated file, you need to use the flow parser.

ybook --parser flow

Credits

npm package: https://www.npmjs.com/package/storybook

github repo: https://github.com/storybooks/storybook-package

Storybook monorepo: https://github.com/storybooks/storybook

in order to have the latest Storybook CLI install:

i -g @storybook/cli