Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Storybook: Try to integrate the playground into Storybook #18191

Merged
merged 11 commits into from
Nov 12, 2019
3 changes: 1 addition & 2 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -203,8 +203,7 @@ jobs:
install:
- npm ci
before_deploy:
- npm run playground:build -- --public-url '/gutenberg'
- npm run design-system:build
- npm run storybook:build
deploy:
provider: pages
skip_cleanup: true
Expand Down
12 changes: 8 additions & 4 deletions docs/contributors/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,10 +61,14 @@ You can also type `npm run package-plugin` which will run the two commands above
[npm]: https://www.npmjs.com/
[nvm]: https://github.com/creationix/nvm

## Playground
## Storybook

The Gutenberg repository also includes a static Gutenberg playground that allows testing and developing in a WordPress-agnostic context. This is very helpful for developing reusable components and trying generic JavaScript modules without any backend dependency.
> Storybook is an open source tool for developing UI components in isolation for React, React Native and more. It makes building stunning UIs organized and efficient.

You can launch the playground by running `npm run playground:dev` locally. The playground should be available on [http://localhost:1234](http://localhost:1234).
The Gutenberg repository also includes [Storybook] integration that allows testing and developing in a WordPress-agnostic context. This is very helpful for developing reusable components and trying generic JavaScript modules without any backend dependency.

You can also test the playground version of the current master branch on GitHub Pages: [https://wordpress.github.io/gutenberg/](https://wordpress.github.io/gutenberg/)
You can launch Storybook by running `npm run storybook:dev` locally. It will open in your browser automatically.

You can also test Storybook for the current `master` branch on GitHub Pages: [https://wordpress.github.io/gutenberg/](https://wordpress.github.io/gutenberg/)

[Storybook]: https://storybook.js.org/
Loading