1
0
Fork 0
mirror of https://github.com/terribleplan/next.js.git synced 2024-01-19 02:48:18 +00:00
next.js/examples/with-storybook/README.md
Michael Herold 5b3578e58f #4751 - Explicitly mention install when cloning examples (#4758)
Preferably this installation wouldn't be necessary, but in lieu of a fix...

#4751
2018-07-11 23:56:15 +02:00

66 lines
1.4 KiB
Markdown

[![Deploy to now](https://deploy.now.sh/static/button.svg)](https://deploy.now.sh/?repo=https://github.com/zeit/next.js/tree/master/examples/with-storybook)
# Example app with Storybook
## How to use
### Using `create-next-app`
Execute [`create-next-app`](https://github.com/segmentio/create-next-app) with [Yarn](https://yarnpkg.com/lang/en/docs/cli/create/) or [npx](https://github.com/zkat/npx#readme) to bootstrap the example:
```bash
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:
```bash
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:
```bash
npm install
npm run dev
# or
yarn
yarn dev
```
## Run Storybook
```bash
npm run storybook
# or
yarn storybook
```
## Build Static Storybook
```bash
npm run build-storybook
# or
yarn build-storybook
```
Deploy Storybook to the cloud with [now](https://zeit.co/now) ([download](https://zeit.co/download))
```bash
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.