From 43693661ef86c683c0b20070a51f6ff8a4f14254 Mon Sep 17 00:00:00 2001 From: Alok Gupta Date: Mon, 22 Jul 2024 14:24:38 +0530 Subject: [PATCH] Updated env docs --- README.md | 11 ++++------- 1 file changed, 4 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 20ad9b39a..905896d48 100644 --- a/README.md +++ b/README.md @@ -42,18 +42,15 @@ 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: +1. 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: +2. Open .env and fill in your actual values for each variable. -| Variable | Description | -| ---------------------------- | ------------------------------------------------- | -| NEXT_PUBLIC_ALGOLIA_API_KEY | Algolia API key for search | -| NEXT_PUBLIC_ALGOLIA_APP_ID | Algolia App ID for search | +3. Save the file. -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). +4. Ensure .env is in your .gitignore. #### Install dependencies