rsnext/examples/with-storybook
Balázs Orbán 335e91800b
chore(examples): remove next-env.d.ts files (#41041)
They are added to `.gitignore` already. Follow-up on #39051


## Bug

- [ ] Related issues linked using `fixes #number`
- [ ] Integration tests added
- [ ] Errors have a helpful link attached, see `contributing.md`

## Feature

- [ ] Implements an existing feature request or RFC. Make sure the
feature request has been accepted for implementation before opening a
PR.
- [ ] Related issues linked using `fixes #number`
- [ ] Integration tests added
- [ ] Documentation added
- [ ] Telemetry added. In case of a feature if it's used or not.
- [ ] Errors have a helpful link attached, see `contributing.md`

## Documentation / Examples

- [ ] Make sure the linting passes by running `pnpm lint`
- [ ] The "examples guidelines" are followed from [our contributing
doc](https://github.com/vercel/next.js/blob/canary/contributing/examples/adding-examples.md)

Co-authored-by: JJ Kasper <jj@jjsweb.site>
2022-09-29 16:39:47 -07:00
..
.storybook Docs: use the nextv12 example from the storybook-addon-next repo as the with-storybook example (#33891) 2022-02-06 04:27:56 +00:00
components Docs: use the nextv12 example from the storybook-addon-next repo as the with-storybook example (#33891) 2022-02-06 04:27:56 +00:00
pages Docs: use the nextv12 example from the storybook-addon-next repo as the with-storybook example (#33891) 2022-02-06 04:27:56 +00:00
public Docs: use the nextv12 example from the storybook-addon-next repo as the with-storybook example (#33891) 2022-02-06 04:27:56 +00:00
stories/pages Docs: use the nextv12 example from the storybook-addon-next repo as the with-storybook example (#33891) 2022-02-06 04:27:56 +00:00
styles Docs: use the nextv12 example from the storybook-addon-next repo as the with-storybook example (#33891) 2022-02-06 04:27:56 +00:00
.gitignore Update default gitignore templates (#39051) 2022-07-26 20:08:40 -05:00
next.config.js [Docs] Add config types to all examples (#40083) 2022-08-31 16:41:22 -05:00
package.json Docs: use the nextv12 example from the storybook-addon-next repo as the with-storybook example (#33891) 2022-02-06 04:27:56 +00:00
README.md docs(examples): improve DX while copying command to create new project (#38410) 2022-07-26 21:57:48 -05:00
tsconfig.json Docs: use the nextv12 example from the storybook-addon-next repo as the with-storybook example (#33891) 2022-02-06 04:27:56 +00:00

Example app with Storybook

This example shows a default set up of Storybook using storybook-addon-next. Included in this example are stories that demonstrate the ability to use Next.js features in Storybook.

TypeScript

As of v6.0, Storybook has built-in TypeScript support, so no configuration is needed. If you want to customize the default configuration, refer to the TypeScript docs.

Deploy your own

Deploy the example using Vercel or preview live with StackBlitz

Deploy with Vercel

How to use

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

npx create-next-app --example with-storybook with-storybook-app
yarn create next-app --example with-storybook with-storybook-app
pnpm create next-app --example with-storybook with-storybook-app

Run Storybook

npm run storybook
# or
yarn storybook

Build Static Storybook

npm run build-storybook
# or
yarn build-storybook

You can use Vercel to deploy Storybook. Specify storybook-static as the output directory.