From 6858ec7e9e02f50056566f508c9fe8bf76f67d4f Mon Sep 17 00:00:00 2001 From: Alok Gupta Date: Sun, 14 Jul 2024 23:57:06 +0530 Subject: [PATCH] Added docs for setting up env variables --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index 45635c591..20ad9b39a 100644 --- a/README.md +++ b/README.md @@ -40,6 +40,22 @@ git submodule init git submodule update ``` +### Setup Enviroment Variables + + Create a new `.env` file by copying the contents of the `.env.example` into `.env` file. Use this command: +``` +cp .env.example .env +``` +This file contains the following environment variables: + +| Variable | Description | +| ---------------------------- | ------------------------------------------------- | +| NEXT_PUBLIC_ALGOLIA_API_KEY | Algolia API key for search | +| NEXT_PUBLIC_ALGOLIA_APP_ID | Algolia App ID for search | + +To get the Algolia API key and App ID, you need to create an account on Algolia. You can find more information on how to get the API key and App ID [here](https://www.algolia.com/doc/guides/security/api-keys/#create-and-manage-your-api-keys). + + #### Install dependencies Install dependencies