next.js/examples/with-storybook/README.md

Example app with Storybook

How to use

Using create-next-app

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

npx create-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

The idea behind the example

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.