Skip to content

Commit e18a631

Browse files
Merge pull request #21 from FLASH2332/docs/add-instructions-for-api-key
docs: add Gemini API key setup to backend deployment guide
2 parents c68cfac + 3e0d476 commit e18a631

2 files changed

Lines changed: 47 additions & 0 deletions

File tree

install/install.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,45 @@ GOOGLE_GENERATIVE_AI_API_KEY=<YOUR_GEMINI_API_KEY>
6262

6363
![env-content](https://i.imgur.com/1uGj3rU.png)
6464

65+
66+
## Obtain a Gemini API Key (Optional – Required for AI Features)
67+
68+
EvOC supports AI-powered features using Google’s **Gemini API**.
69+
To enable these features, you must obtain a Gemini API key and add it to your `.env` file.
70+
71+
### Steps to get a Gemini API key
72+
73+
1. Visit **Google AI Studio**:
74+
https://aistudio.google.com/
75+
76+
2. Sign in with your Google account.
77+
78+
3. Click **Get API key****Create API key**.
79+
80+
4. Select an existing Google Cloud project or create a new one.
81+
82+
5. Copy the generated API key.
83+
84+
### Enable AI features
85+
86+
In your `.env` file:
87+
```env
88+
NEXT_PUBLIC_AI=true
89+
GOOGLE_GENERATIVE_AI_API_KEY=<YOUR_GEMINI_API_KEY>
90+
```
91+
92+
93+
If you do not want AI features, keep:
94+
```
95+
NEXT_PUBLIC_AI=false
96+
```
97+
98+
::: warning
99+
Do not commit your API key to version control.
100+
The .env file should remain private and untracked.
101+
:::
102+
103+
65104
## Run Services
66105

67106
Run all services using the Docker Compose `.yml` file. Execute this command inside the `operations` directory:

package-lock.json

Lines changed: 8 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)