Docs: Added YouTube API key setup instructions #261
Conversation
📝 WalkthroughWalkthroughAdded step-by-step instructions to README.md for obtaining a YouTube API key from Google Cloud Console. The guide covers enabling YouTube Data API v3, creating credentials, configuring access restrictions, and adding the key to the .env file as VITE_YOUTUBE_API_KEY. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
Pre-merge checks✅ Passed checks (5 passed)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
📜 Review details
Configuration used: defaults
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md
🧰 Additional context used
🪛 LanguageTool
README.md
[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)
| 6. Get the Youtube API key: | ||
| - Go to [https://developers.google.com/youtube/registering_an_application]. | ||
| - 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 | ||
| ``` |
There was a problem hiding this comment.
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:
- Move this step into the Frontend Setup section (after step 2), or
- 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.
| dbname=postgres | ||
| ``` | ||
|
|
||
| 6. Get the Youtube API key: |
There was a problem hiding this comment.
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.
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.
| 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.
| ``` | ||
|
|
||
| 6. Get the Youtube API key: | ||
| - Go to [https://developers.google.com/youtube/registering_an_application]. |
There was a problem hiding this comment.
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.
| - 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.
1 participant
Closes #255
📝 Description
Added missing instructions for generating the YouTube Data API v3 key to the main
README.md. This guide helps new contributors set up the environment variables correctly using the official YouTube registration link.🔧 Changes Made
README.mdto include Step 6: Get the Youtube API key.https://developers.google.com/youtube/registering_an_applicationto guide the user through enabling the API, selecting "Public Data", and generating the key for the.envfile.📷 Screenshots or Visual Changes (if applicable)
N/A
🤝 Collaboration
Collaborated with: none
✅ Checklist
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.