círculo

Backend Assignment | FamPay

About the Backend

To provide an API to retrieve the most recent videos from YouTube, arranged in reverse chronological order of their posting date-time, in a paginated response for a particular tag/search query.

Tech Stack

• Python3.8
• Django
• Django Rest Framework
• Celery
• PostgreSQL
• Docker

Getting Started

To get started:

• Clone the repo.

git clone https://github.com/guptaharsh13/circulo

• Change into the directory.

cd circulo

Run

Environment Variables

touch .env

For running this project successfully you'll need to create a .env file and store your firebase credentials there like .env.sample.

python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt
python3 manage.py runserver

Open a new temminal and start the celery worker

celery -A circulo.celery worker -l INFO

Open another temminal and start the celery beat scheduler

celery -A circulo beat -l INFO

Docker Run

Environment Variables

touch .env

For running this project successfully you'll need to create a .env file and store your firebase credentials there like .env.sample.docker.

docker-compose up --build

API Documentation

Once you have launched the app locally, you can access the documentation using the below localhost links

• Swagger
• Redoc

Inspirations

• Why did I use BRIN index for published_on and made_on?
• Why did I use Cursor Pagination?

Future Scope

• Build a TUI
• Implement Elasticsearch

Made with ❤ by Harsh Gupta