Backend Assignment FamPay

Requirements:

• Docker & docker-compose
• Youtube API keys are under .envs/.local/.youtube_api_keys

Functionalities:

• Background (async) with some interval 10 seconds for fetching the latest videos using celery
• Dashboard with paginated videos list
• APIs to search videos via description and title
• multiple YouTube API key support

Basic Commands

To Run the Project

$ docker-compose -f local.py up

API Documentation

Videos List API:

http://localhost:8000/api/videos/

Videos List API Pagination:

http://localhost:8000/api/videos/?page=1

Videos List API Search By Title Or Description:

http://localhost:8000/api/videos/?search=england

Type checks

Running type checks with mypy:

$ mypy backend_assignment_fampay

Test coverage

To run the tests, check your test coverage, and generate an HTML coverage report:

$ coverage run -m pytest
$ coverage html
$ open htmlcov/index.html

Running tests with py.test

$ pytest

Live reloading and Sass CSS compilation

Moved to Live reloading and SASS compilation.

Celery

This app comes with Celery.

To run a celery worker:

cd backend_assignment_fampay
celery -A config.celery_app worker -l info

Please note: For Celery's import magic to work, it is important where the celery commands are run. If you are in the same folder with manage.py, you should be right.

Email Server

In development, it is often nice to be able to see emails that are being sent from your application. For that reason local SMTP server MailHog with a web interface is available as docker container.

Container mailhog will start automatically when you will run all docker containers. Please check cookiecutter-django Docker documentation for more details how to start all containers.

With MailHog running, to view messages that are sent by your application, open your browser and go to http://127.0.0.1:8025

Sentry

Sentry is an error logging aggregator service. You can sign up for a free account at https://sentry.io/signup/?code=cookiecutter or download and host it yourself. The system is setup with reasonable defaults, including 404 logging and integration with the WSGI application.

You must set the DSN url in production.

Deployment

The following details how to deploy this application.

Heroku

See detailed cookiecutter-django Heroku documentation.

Docker

See detailed cookiecutter-django Docker documentation.