Django Deploy on HEROKU

This page explains how to deploy a Django application on Heroku, the popular deployment platform.

Prerequisites

  • Basic programming knowledge in Python

  • Basic Flask knowledge and WSGI concept

  • Comfortable using a terminal

  • Already familiar with GIT - command-line versioning tool

What is Django

Django is a high-level Python Web framework that encourages rapid development and clean, pragmatic design. Built by experienced developers, it takes care of much of the hassle of Web development, so you can focus on writing your app without needing to reinvent the wheel. It's free and open source.

  • Django - official website

  • Django - official documentation

What is HEROKU

Heroku's a fully managed platform that helps developers to deploy apps with ease. Heroku is a cloud-based, fully-managed platform as a service (Paas) for building, running, and managing apps - features:

  • Runtime - Heroku empowers developers to deliver products using a CLI, called Heroku Toolbelt

  • PostgreSQL DBMS - a powerful database already configured to be production-ready

  • Automatic scaling - Heroku scales in an instant, both vertically and horizontally.

  • Github integration - trigger production builds directly from Github commits

To explain the process, we will use a simple Flask Boilerplate already enhanced for a Heroku deployment.

Sample Project

Django Boilerplate is a template codebase used by the AppSeed platform to generate Django Web Apps enhanced with a basic set of features:

  • UI-Ready, simple codebase

  • SQLite database, Flask-SQLAlchemy ORM

  • Session-Based auth flow (login, register) via Flask-Login

  • Deployment scripts: Docker, Gunicorn / Nginx, Heroku

As mentioned, the project comes pre-configured for Heroku. The relevant files are listed below:

  • runtime.txt - specify the Python version used by Heroku during the build and deploy

  • Procfile - configuration file that informs Heroku where to look for the WSGI interface

  • settings.py file - to add the required modules provided by the Heroku platform

Requirements.txt update

To have a successful deployment on Heroku, the usual requirements.txt file should be updated to contain some new modules:

  • gunicorn - the Gunicorn server to start our app

  • django-heroku - a helper bundle provided by the Heroku development team to make the deployment much easier.

File - runtime.txt

To build the deploy any python-based app, Heroku uses a default Python version python-3.6.10 or the one specified in the runtime.txt file. Supported environment, as per Heroku official documentation - Specifying a Python version:

  • python-3.8.3

  • python-3.7.7

  • python-3.8.10 <-- The Default Version

  • python-2.7.18

How to deploy on HEROKU

  • Create a FREE account on the Heroku platform

  • Install the Heroku CLI that match your OS: Mac, Unix, or Windows

  • Open a terminal window and authenticate via heroku login command

  • Clone the sources and push the project for LIVE deployment

The full command list, executed on our sample project.

Step #1 - Clone the project from Github

$ git clone https://github.com/app-generator/boilerplate-code-flask.git
$ cd boilerplate-code-flask

Step #2 - Check HEROKU is installed

$ heroku -v
heroku/7.25.0 win32-x64 node-v12.13.0 # <-- All good

Step #3 - Login to HEROKU plaform using the terminal

$ heroku login
$ # this commaond will open a browser window - click the login button (in browser)

Step #4 - Push LIVE the product

$ # Create the Heroku project
$ heroku create
$
$ # Trigger the LIVE deploy
$ git push heroku master
$
$ # Open the LIVE app in browser
$ heroku open

At this point, you should be able to visit the app in the browser.