mirror of https://github.com/terribleplan/next.js.git synced 2024-01-19 02:48:18 +00:00

Gary Meehan 0da53a1444 Add [with-storybook] example (#4588 )

The purpose of the PR is to add the simplest possible integration with Storybook. 

It leaves the default Storybook and also adds a custom component to show how it would be used in both the app and Storybook.

Update: 
Tested with latest 👉  6.1.1

2018-06-29 22:24:44 +02:00

1.4 KiB

Raw Blame History

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 or clone the repo:

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.

1.4 KiB Raw Blame History