Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mohitdmak/youtubesearchapi
Customized search Yt api wrap
https://github.com/mohitdmak/youtubesearchapi
axios chai docker express mochajs mongo-mongoose youtube-api-v3
Last synced: about 1 month ago
JSON representation
Customized search Yt api wrap
- Host: GitHub
- URL: https://github.com/mohitdmak/youtubesearchapi
- Owner: mohitdmak
- License: mit
- Created: 2021-06-04T13:50:35.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-02-01T04:49:50.000Z (about 2 years ago)
- Last Synced: 2024-11-06T13:56:39.499Z (3 months ago)
- Topics: axios, chai, docker, express, mochajs, mongo-mongoose, youtube-api-v3
- Language: JavaScript
- Homepage:
- Size: 147 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# YoutubeSearchApi
[](https://github.com/mohitdmak/YoutubeSearchApi/actions/workflows/node.js.yml)
## API Paths
> After following the installation process below and starting project, the api shall be listening for requests at port 3000.
- /
> Home path, app shall respond with a simple json acknowledgement
- /search/< query >
> Insert query which you want your Data API v3 to send results for, which will be sorted by latest uploaded and return max responses of 2
( hard coded, can change at ./controllers/searchController.js)
- /find/< query >
> Filter responses by video's title or description or both.
Server expects them to be values of keys:
"title"
"description"
in url query strings.
> The < query > must have been searched for before in order to filter by title or description.
## To start,
Create a Mongo Atlas Connection URI
- Login to Mongo Atlas
- Create a project and build new cluster ( it provides a free sandbox )
- Create Database users and secure network access to your machine's IP only
- Create a database which has 2 collections:
- videos
- searches
- Obtain a connection uri for node version > 14
Get a Youtube Data API V3 key
- Visit Google Api Console, https://console.cloud.google.com/
- Create a new project and enable the Yt Data API v3 at https://console.cloud.google.com/apis/api/youtube.googleapis.com
- Create Credentials and secure the key to allow access to only the created api, and download credentials into your project folder.
- Preferrably procure multiple keys as the project will automatically cycles through keys, as their request quotas get exhausted.
### Get the project in your local machine
- Fork the project
- Clone by following on terminal at preferred directory
```
git clone https://github.com//YoutubeSearchApi.git
```
### Setup the config folder
- Copy and export the Mongo connection uri into a file at
./config/mongouri.js
from your project.
- Copy and export (as an array) the set of all api keys at
./config/apiKey.js
from your project.
### Containerise app
- This requires your machine to have Docker runtime installed. If it isnt already install by refering these
- (Mac OS) https://docs.docker.com/docker-for-mac/install/
- (Windows) https://docs.docker.com/docker-for-windows/install/
- (Linux) https://docs.docker.com/engine/install/ (Browse by distributions)
- Further Install docker compose
https://docs.docker.com/compose/install/
- Create docker image and containers
- You may need to create a user group or else run as sudo
```
docker-compose up --build
```
#### You can run app without docker in case of issues by:
- Initiating project with npm pm
```
npm init -y
```
- Installing dependancies
```
npm install i
```
- Test Npm Script:
```
npm run test
```
- Starting Project
```
npm run start
```