Skip to content

Docs: Add instructions for generating YouTube API Key in Frontend READMEΒ #255

@tiashamaitra

Description

@tiashamaitra

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:

  1. Opening Google Cloud Console and creating credentials.
  2. Enabling the "YouTube Data API v3".
  3. Generating an API key and restricting it properly.
  4. Adding the key to the .env file.

πŸ“‹ 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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions