From a143bc466249dd02dced42eb2173d31879e65bd3 Mon Sep 17 00:00:00 2001 From: Aravind Putrevu Date: Tue, 24 Aug 2021 21:58:11 +0530 Subject: [PATCH] [examples] Add ElasticSearch example (#28043) ## Bug - [ ] Related issues linked using `fixes #number` - [ ] Integration tests added - [ ] Errors have 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 helpful link attached, see `contributing.md` ## Documentation / Examples - [x] Make sure the linting passes --- .../with-elasticsearch/.env.local.example | 3 + examples/with-elasticsearch/.gitignore | 28 ++++ examples/with-elasticsearch/README.md | 78 +++++++++++ .../with-elasticsearch/lib/elasticsearch.js | 21 +++ examples/with-elasticsearch/package.json | 15 +++ examples/with-elasticsearch/pages/_app.js | 7 + examples/with-elasticsearch/pages/index.js | 90 +++++++++++++ .../with-elasticsearch/public/favicon.ico | Bin 0 -> 15086 bytes examples/with-elasticsearch/public/vercel.svg | 4 + .../with-elasticsearch/styles/Home.module.css | 121 ++++++++++++++++++ .../with-elasticsearch/styles/globals.css | 16 +++ 11 files changed, 383 insertions(+) create mode 100644 examples/with-elasticsearch/.env.local.example create mode 100644 examples/with-elasticsearch/.gitignore create mode 100644 examples/with-elasticsearch/README.md create mode 100644 examples/with-elasticsearch/lib/elasticsearch.js create mode 100644 examples/with-elasticsearch/package.json create mode 100644 examples/with-elasticsearch/pages/_app.js create mode 100644 examples/with-elasticsearch/pages/index.js create mode 100644 examples/with-elasticsearch/public/favicon.ico create mode 100644 examples/with-elasticsearch/public/vercel.svg create mode 100644 examples/with-elasticsearch/styles/Home.module.css create mode 100644 examples/with-elasticsearch/styles/globals.css diff --git a/examples/with-elasticsearch/.env.local.example b/examples/with-elasticsearch/.env.local.example new file mode 100644 index 000000000000000..07c5c889085c654 --- /dev/null +++ b/examples/with-elasticsearch/.env.local.example @@ -0,0 +1,3 @@ +ESS_CLOUD_ID= +ESS_CLOUD_USERNAME= +ESS_CLOUD_PASSWORD= \ No newline at end of file diff --git a/examples/with-elasticsearch/.gitignore b/examples/with-elasticsearch/.gitignore new file mode 100644 index 000000000000000..c9512eaab3c601c --- /dev/null +++ b/examples/with-elasticsearch/.gitignore @@ -0,0 +1,28 @@ +# See https://help.github.com/articles/ignoring-files/ for more about ignoring files. + +# dependencies +/node_modules + +# testing +/coverage + +# next.js +/.next/ +/out/ + +# production +/build + +# misc +.DS_Store + +# debug +npm-debug.log* +yarn-debug.log* +yarn-error.log* + +# local env files +.env.local +.env.development.local +.env.test.local +.env.production.local diff --git a/examples/with-elasticsearch/README.md b/examples/with-elasticsearch/README.md new file mode 100644 index 000000000000000..74159992351b038 --- /dev/null +++ b/examples/with-elasticsearch/README.md @@ -0,0 +1,78 @@ +## Example app using Elasticsearch + +[Elasticsearch](https://www.elastic.co/elasticsearch) is a distributed, RESTful search and analytics engine. As the heart of the Elastic Stack, it centrally stores your data for lightning fast search, fine‑tuned relevancy, and powerful analytics that scale with ease. This example will show you how to connect to and use Elasticsearch as your search backend for your Next.js app. + +If you want to learn more about Elasticsearch, visit the following pages: + +- [Elastic Stack](https://https://www.elastic.co/products) +- [Elastic Documentation](https://elastic.co/docs) + +## Deploy your own + +Once you have access to the environment variables you'll need, deploy the example using [Vercel](https://vercel.com?utm_source=github&utm_medium=readme&utm_campaign=next-example): + +[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/git/external?repository-url=https://github.com/vercel/next.js/tree/canary/examples/with-elasticsearch&project-name=with-elasticsearch&repository-name=with-elasticsearch&env=ESS_CLOUD_ID,ESS_CLOUD_USERNAME,ESS_CLOUD_PASSWORD&envDescription=Required%20to%20connect%20the%20app%20with%Elasticsearch) + +## How to use + +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 +npx create-next-app --example with-elasticsearch with-elasticsearch-app +# or +yarn create next-app --example with-elasticsearch with-elasticsearch-app +``` + +## Configuration + +### Set up Elasticsearch + +Set up a Elasticsearch either locally or with [Elastic Cloud for free](https://elastic.co/cloud). + +### Set up environment variables + +Copy the `env.local.example` file in this directory to `.env.local` (which will be ignored by Git): + +```bash +cp .env.local.example .env.local +``` + +Set each variable on `.env.local`: + +- `ESS_CLOUD_ID` - URL for the Elasticsearch instance, if you are using [Elastic Cloud](https://elastic.co/cloud) you can find this in the Elastic Cloud console. +- `ESS_CLOUD_USERNAME` - The username for the Elasticsearch instance you have created, if you are using default user it would be `elastic`. +- `ESS_CLOUD_PASSWORD` - Password for the Elasticsearch instance + +### Run Next.js in development mode + +```bash +npm install +npm run dev + +# or + +yarn install +yarn dev +``` + +Your app should be up and running on [http://localhost:3000](http://localhost:3000)! If it doesn't work, post on [GitHub discussions](https://github.com/vercel/next.js/discussions). + +Please ensure that you have configured the env variables in the `.env.local`, if not you will see the message "You are not connected to Elasticsearch!" in the main page. + +If you see that you are connected, you can refer to the [Elasticsearch NodeJS language client docs](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/index.html) for further instructions on querying Elasticsearch. + +## Deploy on Vercel + +You can deploy this app to the cloud with [Vercel](https://vercel.com?utm_source=github&utm_medium=readme&utm_campaign=next-example) ([Documentation](https://nextjs.org/docs/deployment)). + +#### Deploy Your Local Project + +To deploy your local project to Vercel, push it to GitHub/GitLab/Bitbucket and [import to Vercel](https://vercel.com/new?utm_source=github&utm_medium=readme&utm_campaign=next-example). + +**Important**: When you import your project on Vercel, make sure to click on **Environment Variables** and set them to match your `.env.local` file. + +#### Deploy from Our Template + +Alternatively, you can deploy using our template by clicking on the Deploy button below. + +[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/git/external?repository-url=https://github.com/vercel/next.js/tree/canary/examples/with-elasticsearch&project-name=with-elasticsearch&repository-name=with-elasticsearch&env=ESS_CLOUD_ID,ESS_CLOUD_USERNAME,ESS_CLOUD_PASSWORD&envDescription=Required%20to%20connect%20the%20app%20with%20Elasticsearch) diff --git a/examples/with-elasticsearch/lib/elasticsearch.js b/examples/with-elasticsearch/lib/elasticsearch.js new file mode 100644 index 000000000000000..cd5e21661c21894 --- /dev/null +++ b/examples/with-elasticsearch/lib/elasticsearch.js @@ -0,0 +1,21 @@ +import { Client } from '@elastic/elasticsearch' + +export async function connectToElasticsearch() { + const ESS_CLOUD_ID = process.env.ESS_CLOUD_ID + const ESS_CLOUD_USERNAME = process.env.ESS_CLOUD_USERNAME + const ESS_CLOUD_PASSWORD = process.env.ESS_CLOUD_PASSWORD + + if (!ESS_CLOUD_ID || !ESS_CLOUD_USERNAME || !ESS_CLOUD_PASSWORD) { + return 'ERR_ENV_NOT_DEFINED' + } + + return new Client({ + cloud: { + id: ESS_CLOUD_ID, + }, + auth: { + username: ESS_CLOUD_USERNAME, + password: ESS_CLOUD_PASSWORD, + }, + }) +} diff --git a/examples/with-elasticsearch/package.json b/examples/with-elasticsearch/package.json new file mode 100644 index 000000000000000..dba769002bf1b80 --- /dev/null +++ b/examples/with-elasticsearch/package.json @@ -0,0 +1,15 @@ +{ + "private": true, + "scripts": { + "dev": "next dev", + "build": "next build", + "start": "next start", + "lint": "next lint" + }, + "dependencies": { + "@elastic/elasticsearch": "^7.14.0", + "next": "latest", + "react": "^17.0.2", + "react-dom": "^17.0.2" + } +} diff --git a/examples/with-elasticsearch/pages/_app.js b/examples/with-elasticsearch/pages/_app.js new file mode 100644 index 000000000000000..58ec64709d86101 --- /dev/null +++ b/examples/with-elasticsearch/pages/_app.js @@ -0,0 +1,7 @@ +import '../styles/globals.css' + +function MyElasticsearchApp({ Component, pageProps }) { + return +} + +export default MyElasticsearchApp diff --git a/examples/with-elasticsearch/pages/index.js b/examples/with-elasticsearch/pages/index.js new file mode 100644 index 000000000000000..2a4a49573b13bea --- /dev/null +++ b/examples/with-elasticsearch/pages/index.js @@ -0,0 +1,90 @@ +import Head from 'next/head' +import Image from 'next/image' +import styles from '../styles/Home.module.css' +import { connectToElasticsearch } from '../lib/elasticsearch' + +export default function Home({ isConnected }) { + return ( +
+ + Create Next App + + + + +
+

+ Welcome to{' '} + Next.js with Elasticsearch! +

+ {isConnected ? ( +
You are connected to Elasticsearch
+ ) : ( +
+ You are NOT connected to Elasticsearch. Check the{' '} + README.md for instructions. +
+ )} + +

+ Get started by editing{' '} + pages/index.js +

+ +
+ +

Documentation →

+

Find in-depth information about Next.js features and API.

+ + + +

Learn →

+

Learn about Next.js in an interactive course with quizzes!

+ + + +

Examples →

+

Discover and deploy boilerplate example Next.js projects.

+ + + +

Deploy →

+

+ Instantly deploy your Next.js site to a public URL with Vercel. +

+ +
+
+ + +
+ ) +} + +export async function getServerSideProps(context) { + let isConnected = false + const client = await connectToElasticsearch() + if (client !== 'ERR_ENV_NOT_DEFINED') { + isConnected = true + } + return { + props: { isConnected }, + } +} diff --git a/examples/with-elasticsearch/public/favicon.ico b/examples/with-elasticsearch/public/favicon.ico new file mode 100644 index 0000000000000000000000000000000000000000..4965832f2c9b0605eaa189b7c7fb11124d24e48a GIT binary patch literal 15086 zcmeHOOH5Q(7(R0cc?bh2AT>N@1PWL!LLfZKyG5c!MTHoP7_p!sBz0k$?pjS;^lmgJ zU6^i~bWuZYHL)9$wuvEKm~qo~(5=Lvx5&Hv;?X#m}i|`yaGY4gX+&b>tew;gcnRQA1kp zBbm04SRuuE{Hn+&1wk%&g;?wja_Is#1gKoFlI7f`Gt}X*-nsMO30b_J@)EFNhzd1QM zdH&qFb9PVqQOx@clvc#KAu}^GrN`q5oP(8>m4UOcp`k&xwzkTio*p?kI4BPtIwX%B zJN69cGsm=x90<;Wmh-bs>43F}ro$}Of@8)4KHndLiR$nW?*{Rl72JPUqRr3ta6e#A z%DTEbi9N}+xPtd1juj8;(CJt3r9NOgb>KTuK|z7!JB_KsFW3(pBN4oh&M&}Nb$Ee2 z$-arA6a)CdsPj`M#1DS>fqj#KF%0q?w50GN4YbmMZIoF{e1yTR=4ablqXHBB2!`wM z1M1ke9+<);|AI;f=2^F1;G6Wfpql?1d5D4rMr?#f(=hkoH)U`6Gb)#xDLjoKjp)1;Js@2Iy5yk zMXUqj+gyk1i0yLjWS|3sM2-1ECc;MAz<4t0P53%7se$$+5Ex`L5TQO_MMXXi04UDIU+3*7Ez&X|mj9cFYBXqM{M;mw_ zpw>azP*qjMyNSD4hh)XZt$gqf8f?eRSFX8VQ4Y+H3jAtvyTrXr`qHAD6`m;aYmH2zOhJC~_*AuT} zvUxC38|JYN94i(05R)dVKgUQF$}#cxV7xZ4FULqFCNX*Forhgp*yr6;DsIk=ub0Hv zpk2L{9Q&|uI^b<6@i(Y+iSxeO_n**4nRLc`P!3ld5jL=nZRw6;DEJ*1z6Pvg+eW|$lnnjO zjd|8>6l{i~UxI244CGn2kK@cJ|#ecwgSyt&HKA2)z zrOO{op^o*- + + \ No newline at end of file diff --git a/examples/with-elasticsearch/styles/Home.module.css b/examples/with-elasticsearch/styles/Home.module.css new file mode 100644 index 000000000000000..35454bb748190db --- /dev/null +++ b/examples/with-elasticsearch/styles/Home.module.css @@ -0,0 +1,121 @@ +.container { + min-height: 100vh; + padding: 0 0.5rem; + display: flex; + flex-direction: column; + justify-content: center; + align-items: center; + height: 100vh; +} + +.main { + padding: 5rem 0; + flex: 1; + display: flex; + flex-direction: column; + justify-content: center; + align-items: center; +} + +.footer { + width: 100%; + height: 100px; + border-top: 1px solid #eaeaea; + display: flex; + justify-content: center; + align-items: center; +} + +.footer a { + display: flex; + justify-content: center; + align-items: center; + flex-grow: 1; +} + +.title a { + color: #0070f3; + text-decoration: none; +} + +.title a:hover, +.title a:focus, +.title a:active { + text-decoration: underline; +} + +.title { + margin: 0; + line-height: 1.15; + font-size: 4rem; +} + +.title, +.description { + text-align: center; +} + +.description { + line-height: 1.5; + font-size: 1.5rem; +} + +.code { + background: #fafafa; + border-radius: 5px; + padding: 0.75rem; + font-size: 1.1rem; + font-family: Menlo, Monaco, Lucida Console, Liberation Mono, DejaVu Sans Mono, + Bitstream Vera Sans Mono, Courier New, monospace; +} + +.grid { + display: flex; + align-items: center; + justify-content: center; + flex-wrap: wrap; + max-width: 800px; + margin-top: 3rem; +} + +.card { + margin: 1rem; + padding: 1.5rem; + text-align: left; + color: inherit; + text-decoration: none; + border: 1px solid #eaeaea; + border-radius: 10px; + transition: color 0.15s ease, border-color 0.15s ease; + width: 45%; +} + +.card:hover, +.card:focus, +.card:active { + color: #0070f3; + border-color: #0070f3; +} + +.card h2 { + margin: 0 0 1rem 0; + font-size: 1.5rem; +} + +.card p { + margin: 0; + font-size: 1.25rem; + line-height: 1.5; +} + +.logo { + height: 1em; + margin-left: 0.5rem; +} + +@media (max-width: 600px) { + .grid { + width: 100%; + flex-direction: column; + } +} diff --git a/examples/with-elasticsearch/styles/globals.css b/examples/with-elasticsearch/styles/globals.css new file mode 100644 index 000000000000000..e5e2dcc23baf192 --- /dev/null +++ b/examples/with-elasticsearch/styles/globals.css @@ -0,0 +1,16 @@ +html, +body { + padding: 0; + margin: 0; + font-family: -apple-system, BlinkMacSystemFont, Segoe UI, Roboto, Oxygen, + Ubuntu, Cantarell, Fira Sans, Droid Sans, Helvetica Neue, sans-serif; +} + +a { + color: inherit; + text-decoration: none; +} + +* { + box-sizing: border-box; +}