README - Next Js — ContextQMD

Example app using Elasticsearch

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:

Deploy your own

How to use

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

bash

npx create-next-app --example with-elasticsearch with-elasticsearch-app

bash

yarn create next-app --example with-elasticsearch with-elasticsearch-app

bash

pnpm 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.

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 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! If it doesn't work, post on GitHub 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 for further instructions on querying Elasticsearch.

Deploy on Vercel

You can deploy this app to the cloud with Vercel (Documentation).

Deploy Your Local Project

To deploy your local project to Vercel, push it to GitHub/GitLab/Bitbucket and import to Vercel.

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.