Skip to content
This repository has been archived by the owner on Feb 14, 2023. It is now read-only.
/ music-tube-server Public archive

Music tube is a music video display application which periodically updated the videos from the YouTube Data API.

Notifications You must be signed in to change notification settings

j-tesla/music-tube-server

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

43 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Music Tube Server

Music tube is a music video display application which periodically updated the videos from the YouTube Data API.

Stack used

  • Backend with Express framework for Node.js
  • Frontend with React (with MaterialUI components)
  • MongoDB for database (Used mongoose for modelling)
  • Server is dockerized (MongoDB connection is required to run the server image)

For exact dependencies used frontend and backend, checkout frontend's package.json and backend's package.json

Setup

Prerequisites

Git, Docker

Getting API key for YouTube Data API

  1. Create a project in the Google Developers Console and obtain authorization credentials so your application can submit API requests.
  2. After creating your project, make sure the YouTube Data API is one of the services that your application is registered to use:
    1. Go to the API Console and select the project that you just registered.
    2. Visit the Enabled APIs page. In the list of APIs, make sure the status is ON for the YouTube Data API v3.

Environment

The following environments variables are required.

  • PORT: port on which server communicates
  • YOUTUBE_API_KEY: key obtained earlier
  • DB_URI: mongodb server uri Instead of DB_URI, seperate elements of it can be used: DB_USER, DB_PASSWORD, DB_HOST, DB_PORT, DB_NAME

Usage

  • A build can be run as a container with docker. (Remember to set the environment variables required) Refer Docker documentation for different uses of an image

  • For running locally without bothering about setting up MongoDB, use j-tesla/music-tube


Dashboard is avaialble at root url and API endpoint for videos is at /api/videos

About

Music tube is a music video display application which periodically updated the videos from the YouTube Data API.

Resources

Stars

Watchers

Forks