rsnext/examples/with-eslint
Dominic Elm d2caaeab64
docs: add 'Open in StackBlitz' buttons to various examples (#25853)
This PR adds a `Preview` section and a `Open in StackBlitz` button to various examples. I have tested all examples and omitted the ones that require third party API keys, or didn't work. Some examples don't work locally either.

Here's an example:
![image](https://user-images.githubusercontent.com/12571019/121027783-88971280-c7a7-11eb-851a-0ad30cf74b42.png)

## Bug

- [ ] Related issues linked using `fixes #number`
- [ ] Integration tests added

## 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
- [x] Examples updated
- [ ] Telemetry added. In case of a feature if it's used or not.

## Documentation / Examples

- [x] Make sure the linting passes
2021-06-08 20:45:02 +00:00
..
pages Adds ESLint with default rule-set (#23702) 2021-04-30 11:09:07 +00:00
.eslintrc Adds ESLint with default rule-set (#23702) 2021-04-30 11:09:07 +00:00
.gitignore Adds ESLint with default rule-set (#23702) 2021-04-30 11:09:07 +00:00
next.config.js Adds ESLint with default rule-set (#23702) 2021-04-30 11:09:07 +00:00
package.json Adds ESLint with default rule-set (#23702) 2021-04-30 11:09:07 +00:00
README.md docs: add 'Open in StackBlitz' buttons to various examples (#25853) 2021-06-08 20:45:02 +00:00

ESLint Example

This example shows a Next.js application using the built-in ESLint setup with the next shareable configuration enabled in .eslintrc.

Note: ESLint running during build (next build) is still experimental and needs to be enabled via an { experimental: eslint } flag in next.config.js.

Preview

Preview the example live on StackBlitz:

Open in StackBlitz

Deploy your own

Deploy the example using Vercel:

Deploy with Vercel

How to use

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

npx create-next-app --example with-eslint with-eslint
# or
yarn create next-app --example with-eslint with-eslint

Deploy it to the cloud with Vercel (Documentation).