Skip to content

Commit

Permalink
Updated env docs
Browse files Browse the repository at this point in the history
  • Loading branch information
aialok committed Jul 22, 2024
1 parent 6858ec7 commit 4369366
Showing 1 changed file with 4 additions and 7 deletions.
11 changes: 4 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 4369366

Please sign in to comment.