History

Shu Uesugi 6804039e94 Make example READMEs more consistent (#10124 ) * npx create → npm init * Fix inconsistent instructions * Update amp-first * Update with-graphql-react * with-firebase-cloud-messaging * Update with-higher-order-component * change create-next-app url * Update create-next-app instruction * Update instructions to use npm instead of npx * Move "the idea behind the example" to top * Rename * Rename * Update contributing.md with a README template		2020-01-16 23:23:56 +01:00
..
.storybook	Improve linting rules to catch more errors (#9374 )	2019-11-10 19:24:53 -08:00
components	Add [with-storybook] example (#4588 )	2018-06-29 22:24:44 +02:00
pages	Add [with-storybook] example (#4588 )	2018-06-29 22:24:44 +02:00
stories	Improve linting rules to catch more errors (#9374 )	2019-11-10 19:24:53 -08:00
package.json	Update storybook example to v5.2 with CSF (#9036 )	2019-10-11 11:57:33 +02:00
README.md	Make example READMEs more consistent (#10124 )	2020-01-16 23:23:56 +01:00

README.md

Example app with Storybook

This example shows a default set up of Storybook. Also included in the example is a custom component included in both Storybook and the Next.js application.

How to use

Using `create-next-app`

Execute create-next-app with npm or Yarn to bootstrap the example:

npm init next-app --example with-storybook with-storybook-app
# or
yarn create next-app --example with-storybook with-storybook-app

Download manually

Download the example:

curl https://codeload.github.com/zeit/next.js/tar.gz/canary | tar -xz --strip=2 next.js-canary/examples/with-storybook
cd with-storybook

Install it and run:

npm install
npm run dev
# or
yarn
yarn dev

Run Storybook

npm run storybook
# or
yarn storybook

Build Static Storybook

npm run build-storybook
# or
yarn build-storybook

Deploy Storybook to the cloud with now (download)

npm run build-storybook
# or
yarn build-storybook
# then
cd storybook-static
now