Skip to content

Docs: Added YouTube API key setup instructions #261

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
tiashamaitra wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Docs: Added YouTube API key setup instructions #261

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
14 changes: 14 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,6 +160,20 @@ cd app
dbname=postgres
```

6. Get the Youtube API key:
Copy link
Contributor

@coderabbitai coderabbitai bot Dec 30, 2025

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🔴 Critical

Fix duplicate step numbering: both labeled "Step 6".

Lines 163 and 178 both start with "Step 6", creating ambiguity. The Groq API key step should be renumbered to "Step 7".

🔎 Proposed fix 
-6. Get the Groq API key:
+7. Get the Groq API key:

Also applies to: 178-178

🧰 Tools
🪛 LanguageTool

[uncategorized] ~163-~163: The official name of this popular video platform is spelled with a capital “T”.
Context: ... dbname=postgres ``` 6. Get the Youtube API key: - Go to [https://developers...

(YOUTUBE)

🤖 Prompt for AI Agents 
In README.md around lines 163 and 178, duplicate step numbering uses "Step 6"
twice; change the Groq API key step (line ~178) from "Step 6" to "Step 7" so
numbering is sequential and update any dependent subsequent steps if present to
preserve correct order.

⚠️ Potential issue | 🟡 Minor

Capitalize "YouTube" consistently.

Line 163 uses "Youtube" but line 167 correctly uses "YouTube Data API v3". Standardize to the official product name "YouTube" throughout.

🔎 Proposed fix 
-6. Get the Youtube API key:
+6. Get the YouTube API key:
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
6. Get the Youtube API key:
6. Get the YouTube API key:
🧰 Tools
🪛 LanguageTool

[uncategorized] ~163-~163: The official name of this popular video platform is spelled with a capital “T”.
Context: ... dbname=postgres ``` 6. Get the Youtube API key: - Go to [https://developers...

(YOUTUBE)

🤖 Prompt for AI Agents 
In README.md around line 163, the word "Youtube" is incorrectly capitalized;
change it to the official product name "YouTube" so the line reads "Get the
YouTube API key:" and ensure any other instances of "Youtube" in the document
are updated to "YouTube" for consistent, correct capitalization.

- Go to [https://developers.google.com/youtube/registering_an_application].
Copy link
Contributor

@coderabbitai coderabbitai bot Dec 30, 2025

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Fix malformed markdown link syntax.

The URL on line 164 uses bracket notation [https://...] but lacks the proper markdown link format. Either use:

  • [Google YouTube Registration](https://developers.google.com/youtube/registering_an_application), or
  • Plain text link: https://developers.google.com/youtube/registering_an_application
🔎 Proposed fix 
-   - Go to [https://developers.google.com/youtube/registering_an_application].
+   - Go to [Google YouTube Application Registration](https://developers.google.com/youtube/registering_an_application).
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
- Go to [https://developers.google.com/youtube/registering_an_application].
- Go to [Google YouTube Application Registration](https://developers.google.com/youtube/registering_an_application).
🤖 Prompt for AI Agents 
In README.md around line 164, the link is written as
`[https://developers.google.com/youtube/registering_an_application]` which is
malformed; replace it with a proper Markdown link or a raw URL. Edit the line to
either use a labeled link like "Go to [Google YouTube
Registration](https://developers.google.com/youtube/registering_an_application)"
or simply "Go to
https://developers.google.com/youtube/registering_an_application" so it renders
correctly.

- Under the **API keys** section on that page, click on the link to go to **Create credentials**.
- In the left sidebar, click on **Library**.
- In the search bar that appears, search for **"YouTube Data API v3"**.
- Click **Enable**.
- Once enabled, click the **Create Credentials** button that appears on the page.
- Under "Which API are you using?", select **Public data**.
- (Optional) You may restrict the key if desired.
- Click **Create** to generate the API key.
- Copy the key and paste it into your `.env` file:
```env
VITE_YOUTUBE_API_KEY=your_key_here
```
Comment on lines +163 to +176
Copy link
Contributor

@coderabbitai coderabbitai bot Dec 30, 2025

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟠 Major

Reconsider section placement: YouTube API key instruction belongs in Frontend Setup.

The instructions document VITE_YOUTUBE_API_KEY, which is a Frontend environment variable (per PR objectives and the .env-example reference). However, this guidance appears in the "Backend Setup" section (step 5 is still backend-focused). For clarity, either:

  1. Move this step into the Frontend Setup section (after step 2), or
  2. Clarify that this step applies to both Frontend and Backend setup.

Per the PR objectives, this should guide users through generating credentials needed by the Frontend.

🧰 Tools
🪛 LanguageTool

[uncategorized] ~163-~163: The official name of this popular video platform is spelled with a capital “T”.
Context: ... dbname=postgres ``` 6. Get the Youtube API key: - Go to [https://developers...

(YOUTUBE)

🤖 Prompt for AI Agents 
README.md around lines 163 to 176: the YouTube API key instructions reference
VITE_YOUTUBE_API_KEY (a frontend env var) but are placed in the Backend Setup
section; move this entire step into the Frontend Setup section (after step 2) so
it clearly applies to frontend users, or alternatively add a clarifying note
that the step is required for both frontend and backend if that is
intended—update headings and any cross-references accordingly and ensure the
README’s .env-example and PR objectives are consistent with the new placement.


6. Get the Groq API key:
- Visit [Groq Console](https://console.groq.com/)
Expand Down