Docs: Add instructions for generating YouTube API Key in Frontend README
Assessment
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 58/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Stale
- Tech stack
- google-cloud, typescript, vite
- Domain
- documentation, web-dev
Research direction
Start with Frontend/README.md and compare its setup instructions with the VITE_YOUTUBE_API_KEY entry in Frontend/env-example. Document the Google Cloud Console steps for enabling YouTube Data API v3, creating and restricting an API key, and adding it to the .env file. Done means a new contributor can obtain the key and complete local setup without guessing.
Written by the indexing model from the issue text.
Description
Is this related to an existing part of the documentation?
- Yes, it is related to an existing section
What needs to be updated?
📌 Current Documentation Issue
The Frontend/env-example file requires a VITE_YOUTUBE_API_KEY, but the Frontend/README.md does not explain how to generate this key. New contributors setting up the project locally are stuck guessing how to obtain these credentials from the Google Cloud Console.
✨ Proposed Changes
I propose adding a dedicated section to Frontend/README.md that guides the user through:
- Opening Google Cloud Console and creating credentials.
- Enabling the "YouTube Data API v3".
- Generating an API key and restricting it properly.
- Adding the key to the
.envfile.
📋 Additional Context
I have just set up the project locally and can document the exact steps I took to get it working.
Relevant Documentation Link (if any)
No response
Record
- I agree to follow this project's Code of Conduct
- I want to work on this update
- Dominant language
- TypeScript
- Stars
- 101
- Forks
- 145
- PR merge metrics
- No merged PRs in 30d
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- No contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from AOSSIE-Org/InPactAI
-
UI Bug: Low contrast makes input text unreadable in Sign Up and Login formPossibly taken @Abhik-Mudi claimed this 310 days ago. Open
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
AOSSIE-Org/InPactAI#218 ·
-
DOCS UPDATE: Fix incorrect .env file location in Backend Setup instructionsPossibly taken @PulkitDadwal claimed this 324 days ago. Open
Difficulty 1/5 Under an hour Newbie friendliness 68/100
AOSSIE-Org/InPactAI#201 ·
-
Difficulty 5/5 Over a week Newbie friendliness 42/100
AOSSIE-Org/InPactAI#314 ·
-
Difficulty 5/5 Over a week Newbie friendliness 35/100
AOSSIE-Org/InPactAI#312 ·
-
FEATURE REQUEST: Add API Pagination to Backend List EndpointsMay be free again @alphacoder-hash claimed this 196 days ago, and no pull request is open. Open
Difficulty 4/5 3-5 days Newbie friendliness 50/100
AOSSIE-Org/InPactAI#307 · 2 comments ·
All issues in AOSSIE-Org/InPactAI
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
openwatersio/slackwater-database#281 ·
Maintainers usually reply within 1 day
-
accepted bug via-triage
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
pingdotgg/t3code#18690 · 1 comment ·
Maintainers usually reply within 1 day
-
Bayern feature:Application ready web
Difficulty 2/5 1-3 hours Newbie friendliness 67/100
digitalfabrik/entitlementcard#3176 ·
Maintainers usually reply within 7 days
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
NanmiCoder/cc-haha#1533 · 1 comment ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
Maintainers usually reply within 1 day