Skip to content

Commit

Permalink
Merge pull request storybookjs#3606 from Plsr/document-rn-startup-opt…
Browse files Browse the repository at this point in the history
…ions

Document parameters for start command for RN
  • Loading branch information
danielduan authored May 20, 2018
2 parents 55c6f7b + 52e410f commit c007433
Showing 1 changed file with 37 additions and 0 deletions.
37 changes: 37 additions & 0 deletions app/react-native/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,43 @@ Now update your storybook `package.json` script to the following

The metro bundler requires an absolute path to the config. The above setup assumes the `rn-cli.config.js` is in the root of your project or next to your `package.json`

## Start Command Parameters

The following parameters can be passed to the start command:

```
-h, --host <host>
host to listen on
-p, --port <port>
port to listen on
--haul <configFile>
use haul with config file
--platform <ios|android|all>
build platform-specific build
-s, --secured
whether server is running on https
-c, --config-dir [dir-name]
storybook config directory
--metro-config [relative-config-path]
Metro Bundler Custom config
-e, --environment [environment]
DEVELOPMENT/PRODUCTION environment for webpack
-r, --reset-cache
reset react native packager
--skip-packager
run only storybook server
-i, --manual-id
allow multiple users to work with same storybook
--smoke-test
Exit after successful start
--packager-port <packagerPort>
Custom packager port
--root [root]
Add additional root(s) to be used by the packager in this project
--projectRoots [projectRoots]
Override the root(s) to be used by the packager
```

## Learn More

Check the `docs` directory in this repo for more advanced setup guides and other info.

0 comments on commit c007433

Please sign in to comment.