https://github.com/aitikgupta/famapi

FamAPI: Bringing Fam-end and Pay-end together
https://github.com/aitikgupta/famapi

Last synced: 26 days ago
JSON representation

FamAPI: Bringing Fam-end and Pay-end together

• Host: GitHub
• URL: https://github.com/aitikgupta/famapi
• Owner: aitikgupta
• Created: 2021-07-16T11:46:48.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2021-07-17T05:47:57.000Z (over 3 years ago)
• Last Synced: 2023-10-20T16:18:04.721Z (about 1 year ago)
• Language: Python
• Homepage:
• Size: 1.76 MB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# FamAPI

This application is a demonstration of following APIs:

- Calls YouTube APIs continuously in background with some intervals

- Fetches latest videos and stores specific fields with indexing in database (MongoDB)

- A GET API which returns the stored video data in a paginated response sorted in descending order of published datetime

- A basic search API to search the stored videos using their title and description

---

Hosts FamEnd (client) at `localhost:8080` and PayEnd (server) at `localhost:3000`.

---

## Steps to run

The very first step would be to create a `.env` file in `PayEnd` directory (or set an environment variable):

```sh

GOOGLE_API_KEYS=api,keys,separated,by,comma

```

NOTE: To get the keys, follow [YouTube's specifications](https://developers.google.com/youtube/v3/getting-started).

The whole project is dockerized (by composing dockerized versions of client and server individually), to set everything up:

```console

docker-compose build && docker-compose up

```

That's it! Or, if you prefer a non-dockerized solution:

1. < in PayEnd directory >

   ```console

   pip install -r requirements.txt

   python server.py

   ```

2. < in FamEnd directory >

   ```console

   npm install

   npm start

   ```

## How to test

The client (FamEnd) hosts a `Search` functionality with pagination. Here's some screenshots:

#### Search box

![image](./Screenshots/Search_Header.png)

### Video Card

(blurred due to copyrights)

![image](./Screenshots/VideoCard_Next.png)

### Sample Logs from PayEnd

(cropped because of the API key)

![image](./Screenshots/Server_Logs.png)

## About

Aitik Gupta - [aitikgupta.com/](https://aitikgupta.com/)