Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(documentation) : updated docs for setting up environment variables #797

Merged
merged 2 commits into from
Jul 29, 2024
Merged

chore(documentation) : updated docs for setting up environment variables #797

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6858ec7
Added docs for setting up env variables
aialok Jul 14, 2024
4369366
Updated env docs
aialok Jul 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).
aialok marked this conversation as resolved.
Show resolved Hide resolved


#### Install dependencies

Install dependencies
Expand Down