Cybernomad
/
youtube-api
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
This is a simple app for a code challenge to interface with the YouTube API.
3 Commits
1 Branch
0 Tags
70 KiB
JavaScript 95.3%
HTML 3.4%
CSS 1.3%
 
 
 
Go to file
jeremy 423166adc8 added testing framework vitest and docs in a readme.md 2024-10-07 21:07:59 -05:00
public initial push, added main app wrapper component, a youtube service o fetch the youtube data, key in .env not pushed, and pagination 2024-10-07 19:57:15 -05:00
src initial push, added main app wrapper component, a youtube service o fetch the youtube data, key in .env not pushed, and pagination 2024-10-07 19:57:15 -05:00
test added testing framework vitest and docs in a readme.md 2024-10-07 21:07:59 -05:00
.gitignore initial push, added main app wrapper component, a youtube service o fetch the youtube data, key in .env not pushed, and pagination 2024-10-07 19:57:15 -05:00
LICENSE Initial commit 2024-10-07 19:50:19 -05:00
README.md added testing framework vitest and docs in a readme.md 2024-10-07 21:07:59 -05:00
index.html initial push, added main app wrapper component, a youtube service o fetch the youtube data, key in .env not pushed, and pagination 2024-10-07 19:57:15 -05:00
package-lock.json added testing framework vitest and docs in a readme.md 2024-10-07 21:07:59 -05:00
package.json added testing framework vitest and docs in a readme.md 2024-10-07 21:07:59 -05:00

README.md

YouTube API Interface

A simple app for interacting with the YouTube API.

Description

This project provides a basic interface for searching and displaying YouTube videos. It uses the YouTube API to fetch video data and displays the results in a grid.

Tools used

  • vite with the vanilla js template
  • lit

Features

  • Search for videos by keyword
  • Sort search results by relevance, date, or rating
  • Display video thumbnails, titles, and descriptions
  • Link to YouTube video pages
  • Pagination for large result sets

Dependencies

This project uses the following dependencies:

  • axios for making API requests
  • dotenv for environment variable management
  • lit for building the UI component
  • twind for styling

Setup

  1. Clone the repository: git clone https://gitea.jeremyhayes.me/Cybernomad/youtube-api.git
  2. Install dependencies: npm install or if you prefer npm i
  3. Create a .env file with your YouTube API key: API_KEY=YOUR_API_KEY_HERE
  4. Start the development server: npm run dev

Usage

  1. Open the app in your browser: http://localhost:5173
  2. Enter a search keyword in the input field
  3. Select a sort option from the dropdown menu
  4. Click the "Search" button to fetch video data
  5. Browse the search results and click on a video to open its YouTube page

Contributing

Contributions are welcome! If you'd like to report an issue or submit a pull request, please use the GitHub issue tracker.

License

This project is licensed under the MIT License. See the LICENSE file for details.