Updated example

lfades · lfades · commit e127d7eed331 · 2020-08-14T00:32:32.000-05:00
diff --git a/examples/with-msw/.env b/examples/with-msw/.env
@@ -0,0 +1,4 @@
+# Enable API mocking in all environments, this is only for the sake of the example.
+# In a real app you should move this variable to `.env.development`, as mocking the
+# API should only be done for development.
+NEXT_PUBLIC_API_MOCKING="enabled"
diff --git a/examples/with-msw/README.md b/examples/with-msw/README.md
@@ -6,35 +6,24 @@ In this example we integrate Mock Service Worker with Next by following the next
 
 1. Define a set of [request handlers](./mocks/handlers.js) shared between client and server.
 1. Setup a [Service Worker instance](./mocks/browser.js) that would intercept all runtime client-side requests via `setupWorker` function.
-1. Setup a ["server" instance](./mocks/server.js) to intercept any server/build time requests (e.g. the one happening in `getInitialProps` or `getServerSideProps`) via `setupServer` function.
+1. Setup a ["server" instance](./mocks/server.js) to intercept any server/build time requests (e.g. the one happening in `getServerSideProps`) via `setupServer` function.
 
-## How to use
-
-### Using `create-next-app`
-
-Execute `create-next-app` with `Yarn` or `npx` to bootstrap the example:
+Mocking is enabled using the `NEXT_PUBLIC_API_MOCKING` environment variable, which for the sake of the example is saved inside `.env` instead of `.env.development`. In a real app you should move the variable to `.env.development` because mocking should only be done for development.
 
-```bash
-npx create-next-app --example with-msw
-# or
-yarn create next-app --example with-msw
-```
+## Deploy your own
 
-### Download manually
+Deploy the example using [Vercel](https://vercel.com):
 
-Download the example:
+[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/import/project?template=https://github.com/vercel/next.js/tree/canary/examples/with-msw)
 
-```bash
-curl https://codeload.github.com/vercel/next.js/tar.gz/canary | tar -xz --strip=2 next.js-canary/examples/with-msw
-cd with-msw
-```
+## How to use
 
-Install it and run:
+Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app) with [npm](https://docs.npmjs.com/cli/init) or [Yarn](https://yarnpkg.com/lang/en/docs/cli/create/) to bootstrap the example:
 
 ```bash
-npm install
-npm run dev
+npx create-next-app --example with-msw with-msw-app
 # or
-yarn
-yarn dev
+yarn create next-app --example with-msw with-msw-app
 ```
+
+Deploy it to the cloud with [Vercel](https://vercel.com/import?filter=next.js&utm_source=github&utm_medium=readme&utm_campaign=next-example) ([Documentation](https://nextjs.org/docs/deployment)).
diff --git a/examples/with-msw/next.config.js b/examples/with-msw/next.config.js
diff --git a/examples/with-msw/pages/_app.js b/examples/with-msw/pages/_app.js
@@ -1,4 +1,4 @@
-if (process.env.enableApiMocking) {
+if (process.env.NEXT_PUBLIC_API_MOCKING === 'enabled') {
   require('../mocks')
 }
 
