diff --git a/examples/with-algolia-react-instantsearch/README.md b/examples/with-algolia-react-instantsearch/README.md index 0a4d72103d1b37..254783eb6be7c3 100644 --- a/examples/with-algolia-react-instantsearch/README.md +++ b/examples/with-algolia-react-instantsearch/README.md @@ -12,4 +12,9 @@ npx create-next-app --example with-algolia-react-instantsearch with-algolia-reac yarn create next-app --example with-algolia-react-instantsearch with-algolia-react-instantsearch-app ``` +To set up Algolia: + +- create an [algolia](https://www.algolia.com/) account or use this already [configured index](https://community.algolia.com/react-instantsearch/Getting_started.html#before-we-start) +- update the `appId`, `apikey` and `indexName` you want to search on in [`components/instantsearch.js`](components/instantsearch.js) + 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-firebase-hosting/README.md b/examples/with-firebase-hosting/README.md index c9b9836e4b7f3c..0aad56b34cc056 100644 --- a/examples/with-firebase-hosting/README.md +++ b/examples/with-firebase-hosting/README.md @@ -23,7 +23,23 @@ npx create-next-app --example with-firebase-hosting with-firebase-hosting-app yarn create next-app --example with-firebase-hosting with-firebase-hosting-app ``` -Update `.firebaserc`: adding your firebase project ID +**Important:** Update `.firebaserc` and add your firebase project ID. + +To run Firebase locally for testing: + +```bash +npm run serve +# or +yarn serve +``` + +To deploy it to the cloud with Firebase: + +```bash +npm run deploy +# or +yarn deploy +``` ## Typescript diff --git a/examples/with-http2/README.md b/examples/with-http2/README.md index 929cb225901adb..1622829278ec1e 100644 --- a/examples/with-http2/README.md +++ b/examples/with-http2/README.md @@ -12,4 +12,11 @@ npx create-next-app --example with-http2 with-http2-app yarn create next-app --example with-http2 with-http2-app ``` +Create the public and private keys: + +```bash +openssl req -x509 -newkey rsa:2048 -nodes -sha256 -subj '/CN=localhost' \ + -keyout localhost-privkey.pem -out localhost-cert.pem +``` + 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-reason-relay/README.md b/examples/with-reason-relay/README.md index 336df5af79cdf0..74e4d8ad737c9c 100644 --- a/examples/with-reason-relay/README.md +++ b/examples/with-reason-relay/README.md @@ -20,4 +20,30 @@ npx create-next-app --example with-reason-relay with-reason-relay yarn create next-app --example with-reason-relay with-reason-relay ``` +Download schema introspection data from configured Relay endpoint: + +```bash +npm run schema +# or +yarn schema +``` + +Run Relay ahead-of-time compilation (should be re-run after any edits to components that query data with Relay) + +```bash +npm run relay +# or +yarn relay +``` + +Build and run the Relay project + +```bash +npm run build +npm run dev +# or +yarn build +yarn dev +``` + 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-stomp/.env b/examples/with-stomp/.env new file mode 100644 index 00000000000000..e5e8598191bd91 --- /dev/null +++ b/examples/with-stomp/.env @@ -0,0 +1 @@ +NEXT_PUBLIC_STOMP_SERVER=wss://some.stomp.server \ No newline at end of file diff --git a/examples/with-stomp/README.md b/examples/with-stomp/README.md index bada8883bba8b0..744ac4818c9bfc 100644 --- a/examples/with-stomp/README.md +++ b/examples/with-stomp/README.md @@ -15,3 +15,7 @@ npx create-next-app --example with-stomp with-stomp-app # or yarn create next-app --example with-stomp with-stomp-app ``` + +You'll need to provide the STOMP url of your server before running the app. Open [`.env`](.env) and update the `NEXT_PUBLIC_STOMP_SERVER` environment variable. + +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-stomp/next.config.js b/examples/with-stomp/next.config.js deleted file mode 100644 index e50328de42e1ec..00000000000000 --- a/examples/with-stomp/next.config.js +++ /dev/null @@ -1,6 +0,0 @@ -module.exports = { - // Build-time configuration - env: { - STOMP_SERVER: process.env.STOMP_SERVER, - }, -} diff --git a/examples/with-stomp/useClient.js b/examples/with-stomp/useClient.js index 05714754e1eee5..2cb56c6b1f5ede 100644 --- a/examples/with-stomp/useClient.js +++ b/examples/with-stomp/useClient.js @@ -8,7 +8,7 @@ const useClient = () => { React.useEffect(() => { if (!stompClient) { - stompClient = Stomp.client(process.env.STOMP_SERVER) + stompClient = Stomp.client(process.env.NEXT_PUBLIC_STOMP_SERVER) } if (!client) { setClient(stompClient) diff --git a/examples/with-webassembly/README.md b/examples/with-webassembly/README.md index 6694b39cbd850f..533a7764d46eae 100644 --- a/examples/with-webassembly/README.md +++ b/examples/with-webassembly/README.md @@ -12,4 +12,14 @@ npx create-next-app --example with-webassembly with-webassembly-app yarn create next-app --example with-webassembly with-webassembly-app ``` +This example uses Rust compiled to wasm, the wasm file is included in the example, but to compile your own Rust code you'll have to [install](https://www.rust-lang.org/learn/get-started) Rust. + +To compile `src/add.rs` to `add.wasm` run: + +```bash +npm run build-rust +# or +yarn build-rust +``` + 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-zones/README.md b/examples/with-zones/README.md index a5f1ce7f4a8f43..b7c189666fdc44 100644 --- a/examples/with-zones/README.md +++ b/examples/with-zones/README.md @@ -23,6 +23,14 @@ npx create-next-app --example with-zones with-zones-app yarn create next-app --example with-zones with-zones-app ``` +Install the dependencies of every app (`/home` and `/blog`): + +```bash +npm install +# or +yarn +``` + Install the [Vercel CLI](https://vercel.com/download) if you don't have it already, and then run [`vercel dev`](https://vercel.com/docs/cli?query=dev#commands/dev) in the main directory to start the development server: ```bash