Video downloading platform

Download video from various sources.

License: GPL v3

Settings

To learn how to change application's settings, please refer to the Cookiecutter documentation.

Basic Commands

Setting Up Your Users

• To create a normal user account, just go to Sign Up and fill out the form. Once you submit it, you'll see a "Verify Your E-mail Address" page. Go to your console to see a simulated email verification message. Copy the link into your browser. Now the user's email should be verified and ready to go.

• To create an superuser account, use this command:

$ python manage.py createsuperuser

For convenience, you can keep your normal user logged in on Chrome and your superuser logged in on Firefox (or similar), so that you can see how the site behaves for both kinds of users.

Type checks

Running type checks with mypy:

$ mypy video_downloading_platform

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

To learn how to use live reloading and Sass CSS compilation, please refer to the Cookiecutter documentation.

Deployment

The following details how to deploy this application. After having deployed VHS, please refer to the administration guide.

Docker

To learn how to deploy this application with Docker, please refer to the Cookiecutter documentation.

Azure

To learn how to deploy this application on Microsoft Azure, please refer to our step-by-step guide.

Custom Bootstrap Compilation

The generated CSS is set up with automatic Bootstrap recompilation with variables of your choice. Bootstrap v4 is installed using npm and customised by tweaking your variables in static/sass/custom_bootstrap_vars.

You can find a list of available variables in the bootstrap source, or get explanations on them in the Bootstrap docs. Bootstrap's javascript as well as its dependencies is concatenated into a single file: static/js/vendors.js.