A simple real-time application built using the YouTube API v3 that searches for and displays videos related to your favourite topic.

The application fetches new data periodically and organizes it in a user-friendly Grafana dashboard that helps you to view and query your favourite videos.

You can use the youtube-api-app by sending simple GET requests to the respective endpoints. For each request, you will receive corresponding video data, organised in the following key-value pairs:

A Postman collection has been included in the test/ directory. You can use it to test the application's endpoints.

You can fetch paginated videos from the database by sending a GET request to the /fetch endpoint.

curl --location --request GET 'localhost:5000/fetch'

You can also specify a page_id to fetch a specific page of videos.

curl --location --request GET 'localhost:5000/fetch?page_id=1'

You can search for a video by sending a GET request to the /search endpoint with a title and description query parameter.

curl --location --request GET 'localhost:5000/search?title=dogs&description=cute and friendly'

You can view the data in a Grafana dashboard by visiting localhost:3000 and navigating to the FamPay dashboard.

1. The first step is to download the fastText embedding model for query retrieval. You can download the pretrained models from here. Place both the .bin and .npy files in a folder named model/ in the root of the application.

2. Create a .env file with the following variables.

   • Replace YOUTUBE_API_KEY with your own YouTube API key - you can follow the instructions here to get one
   • Leave GRAFANA_API_KEY empty for now - we will replace it later
   • If you would like to use a different database connection for the application, you can replace DATABASE_URL with your own connection string and DATABASE_* variables with the corresponding credentials

   YOUTUBE_API_KEY=""
   
   DATABASE_URL="postgresql://postgres:postgres@postgres:5432/postgres"
   DATABASE_USER="postgres"
   DATABASE_PASSWORD="postgres"
   DATABASE_HOST="postgres"
   DATABASE_PORT="5432"
   DATABASE_NAME="postgres"
   
   GRAFANA_URL="http://localhost:3000"
   GRAFANA_API_KEY=""

3. While building the application, you can specify the following command line arguments. All of the arguments are optional and they will take their default values if no argument is provided. You can also change the default values arguments for the application in app/app.py

   Argument	Default	Description
   QUERY	fampay	Your query
   TIME	10	Time interval in minutes to fetch results
   MAX_RESULTS	5	Total number of results to return during search
   HOST	0.0.0.0	Host IP on which to run the application
   PORT	5000	Port number on which to run the application

   Specify the argument as VARIABLE=VALUE before the docker-compose command.

   Examples:

   QUERY=dogs docker-compose --project-name youtube-api-app up -d

   QUERY=cats TIME=3 MAX_RESULTS=10 docker-compose --project-name youtube-api-app up -d

4. Visit localhost:3000 in your browser to view the Grafana dashboard. Navigate to Settings, and then API Keys. Generate a new API key with the Admin role.

5. Access the grafana container using the following command:

   docker exec -it grafana bash

   • Open the .env file using the following command:

     vi .env

   • Move your cursor to the line containing GRAFANA_API_KEY. Press I to enter insert mode and then paste your API key here. Exit insert mode by pressing Esc on your keyboard. Finally save and exit using :wq.
   • Run the following command to setup the Grafana dashboard:

     ./setup/setup_grafana.sh

   • Exit the container by typing exit
   • Restart the grafana container using the following command:

     docker restart grafana

6. Refresh the dashboard at localhost:3000 in your browser. You should see the dashboard with the videos that you searched for in the FamPay YouTube API Search dashboard directory.