Skip to content

Docs: Improve local setup instructions for API keys & .env file structure #215

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

Open
vinayak302004 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Docs: Improve local setup instructions for API keys & .env file structure #215

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
47 changes: 45 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ pip install -r requirements.txt

3. Navigate to the app directory:
```sh
cd app
cd backend/app
```

4. Create a `.env` file using `.env-example` as a reference.
Expand Down Expand Up @@ -165,6 +165,49 @@ cd app
- Visit [Groq Console](https://console.groq.com/)
- Create an API key and paste it into the `.env` file

7. Get the Gemini API key:
- Visit [Google AI Studio](https://aistudio.google.com/)
- SignIn/SignUp with Google account
- Click "API Keys" left side panel
- Click "Create API Key"
- Name your key "..." and select "Default Gemini Project"
- Click "Create key"
- Paste the API KEy into the `.env` file
Comment on lines +168 to +175
Copy link
Contributor

@coderabbitai coderabbitai bot Dec 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major

🧩 Analysis chain

🌐 Web query:

Google AI Studio create API key current instructions 2025

💡 Result:

Steps (current, 2025)

  1. Sign in to Google AI Studio (ai.google.dev / aistudio). [1]
  2. If you don’t have a Cloud project in AI Studio: Dashboard → Projects → Import projects (or create a new Google Cloud project in Cloud Console). [1]
  3. In AI Studio Dashboard open API Keys → Create API key → choose the Google Cloud project to attach the key to → confirm. Copy the generated key. [1]
  4. Use the key securely (set as GEMINI_API_KEY or GOOGLE_API_KEY environment variable for clients; or provide explicitly for REST/browser use). [1][3]
  5. If AI Studio can’t create a project/key (permission error), create the key directly in Google Cloud Console: Cloud Console → APIs & Services → Credentials → Create credentials → API key, then use that key in AI Studio or your app. Ensure your account has apikeys.keys.create, resourcemanager.projects.update and serviceusage.services.enable if you want AI Studio to create keys for you. [2]

Sources:
[1] Google AI for Developers — Using Gemini API keys / AI Studio docs.
[2] Google AI Studio community support + GCP Console instructions.
[3] Google AI for Developers — Build mode / key usage recommendations.

Fix typo and update Gemini API key steps to match current UI.

Line 175 contains a typo: "Paste the API KEy" should be "Paste the API Key".

The documented steps are outdated. Current Google AI Studio interface (2025) differs from the substeps listed:

  • API Keys is accessed via Dashboard → API Keys, not a left side panel
  • The UI no longer uses "Default Gemini Project" terminology
  • Users must first create or import a Google Cloud project before generating API keys
  • The key naming step described does not match the current flow

Update the instructions to reflect: Sign in to ai.google.dev, navigate to Dashboard → API Keys → Create API key, select/create a Google Cloud project, then copy the generated key for use in the .env file.

🤖 Prompt for AI Agents 
In README.md around lines 168 to 175, fix the typo ("Paste the API KEy" → "Paste
the API Key") and update the Gemini API key setup steps to match the 2025 Google
AI Studio flow: instruct users to sign in at ai.google.dev (or Google AI
Studio), navigate to Dashboard → API Keys → Create API key, ensure they select
or create/import the appropriate Google Cloud project when prompted, then copy
the generated API key and paste it into the .env file; replace references to
"left side panel" and "Default Gemini Project" with the updated navigation and
project selection instructions.

⚠️ Potential issue | 🟠 Major

🧩 Analysis chain

🌐 Web query:

Google AI Studio API key creation steps 2025 current interface

💡 Result:

Steps (current AI Studio flow, 2025):

  1. Sign in to Google AI Studio (ai.google.com/studio) and open the Dashboard. [1]
  2. Import the Google Cloud project you want to use: Dashboard → Projects → Import projects → search/select your project → Import. (AI Studio only shows imported projects.) [1]
  3. After import, open Dashboard → API Keys (or “API Keys” in the left menu) and click Create API key. Choose the imported GCP project to associate the key; copy the key when shown. [1]
  4. (If AI Studio cannot create a key) Create an API key directly in Google Cloud Console: Cloud Console → Menu → APIs & Services → Credentials → Create credentials → API key. Then restrict the key and enable required APIs (e.g., Generative Language/Gemini). [2][3]
  5. Set the key locally as GEMINI_API_KEY or GOOGLE_API_KEY (server-side preferred) and follow Google’s best practices for key restrictions and security. [1]

Notes: Creating keys from AI Studio requires IAM permissions such as apikeys.keys.create, serviceusage.services.enable and resourcemanager.projects.update; if you lack permissions, use the Cloud Console or ask your admin. [1][3]

Sources: Google AI Studio “Using Gemini API keys” tutorial and Google Cloud API Keys docs. [1][2][3]

Fix typo and update Gemini API key creation steps to match current Google AI Studio interface.

Line 175: "API KEy" should be "API Key".

The steps in lines 168-175 are incomplete and don't match the current Google AI Studio workflow (2025). The current process requires:

  1. Importing a Google Cloud project into AI Studio first (Dashboard → Projects → Import projects)
  2. Creating the API key after import (Dashboard → API Keys or left menu → Create API key)
  3. Associating the key with the imported GCP project

The README skips the project import step entirely, which may cause users to fail if they attempt to follow these steps. Additionally, the URL should reference ai.google.com/studio instead of aistudio.google.com.

Consider updating the steps to include project import and clarifying the association with GCP projects.

🤖 Prompt for AI Agents 
In README.md around lines 168 to 175, fix the typo "API KEy" → "API Key", update
the URL to https://ai.google.com/studio, and replace the current Gemini API key
steps with the current workflow: first import your Google Cloud project into AI
Studio (Dashboard → Projects → Import projects), then navigate to Dashboard →
API Keys (or left menu → Create API key) to create a key, ensure you
associate/choose the imported GCP project when creating the key, and finally
paste the generated API Key into your .env file.


8. Final `.env` file should look:

```sh
SUPABASE_URL=[URL]
SUPABASE_KEY=[URL]

user=postgres
password=[YOUR-PASSWORD]
host=db.wveftanaurduixkyijhf.supabase.co
port=5432
dbname=postgres

GROQ_API_KEY=[URL]

GEMINI_API_KEY=[URL]
```

[The above works in ipv6 networks, if you are in ipv4 network or it cause errors, use the below connection string which could be found in Session Pooler connection]

```sh
SUPABASE_URL=[URL]
SUPABASE_KEY=[URL]

user=postgres.<project>
password=[YOUR-PASSWORD]
host=aws-<location>.pooler.supabase.com
port=5432
dbname=postgres

GROQ_API_KEY=[URL]

GEMINI_API_KEY=[URL]
```

#### 4. Start Development Servers


Expand All @@ -173,7 +216,7 @@ cd app
npm run dev
```

2. Start the backend server (from the backend/app directory):
2. Start the backend server (from the backend directory):
```sh
uvicorn main:app --reload
Comment on lines +219 to 221
Copy link
Contributor

@coderabbitai coderabbitai bot Dec 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major

Verify backend startup command matches actual directory structure.

The startup command uvicorn main:app --reload assumes main.py exists at the backend/ root. However, if main.py is in backend/app/ (as suggested by line 130's attempted navigation), the command should be uvicorn app.main:app --reload.

Resolve the directory structure issue at lines 128–131 first, then update this command accordingly.

🤖 Prompt for AI Agents 
README.md around lines 219 to 221: the startup command currently assumes main.py
is at backend/, but other lines indicate main.py lives in backend/app/; adjust
the repository layout or the command so they match — either move main.py to
backend/ or (preferred) update the command to reference the package path by
changing the instruction to use uvicorn app.main:app --reload and also verify
and correct the related navigation instructions at lines 128–131 to reflect
running from the backend directory.

```
Expand Down