Python 3.8 + Django 3.2 + Postgres 13 + Heroku config

Use this template to start the backend development of your projects with Django

├── apps
│   ├── main
│   │   ├── fixtures
│   │   │   └── development.json
│   │   ├── migrations
│   │   ├── models
│   │   │   └── __init__.py
│   │   │   └── base_model.py
│   │   ├── tests
│   │   │   └── __init__.py
│   │   ├── __init__.py
│   │   ├── admin.py
│   │   ├── apps.py
│   │   └── views.py
│   └── __init__.py
├── htmlcov
├── project_name
│   ├── settings
│   │   ├── partials
│   │   │   └── utils.py
│   │   ├── __init__.py
│   │   ├── common.py
│   │   ├── development.py
│   │   ├── production.py
│   │   └── test.py
│   ├── static
│   ├── __init__.py
│   ├── asgi.py
│   ├── storage_backends.py
│   ├── urls.py
│   └── wsgi.py
├── scripts
│   ├── dev-entrypoint.sh
│   ├── prod-entrypoint.sh
│   └── wait-for-it.sh
├── .coveragerc
├── .editorconfig
├── .envrc
├── .gitignore
├── Dockerfile
├── Makefile
├── README.md
├── docker-compose.override.yml
├── docker-compose.yml
├── heroku.yml
├── manage.py
├── requirements.txt
└── test-requirements.txt

Clone the repository, and update your origin url:

https://github.com/drestrepob/django-docker.git project_name
cd project_name

Merge the addons required by your project (Optional):

git merge origin/celery

Rename your project files and directories:

make name=project_name init

Info: Make is required, for mac run brew install make

After this command you can already delete the init command inside the Makefile

The command before will remove the .git folder, so you will have to initialize it again:

git init
git remote add origin <repository-url>

The project use docker, so just run:

docker-compose up

If it's first time, the images will be created. Sometimes the project doesn't run at first time because the init of postgres, just run again docker-compose up and it will work.

Your app will run in url localhost:8000

To recreate the docker images after dependencies changes run:

docker-compose up --build

To remove the docker containers including the database (Useful sometimes when dealing with migrations):

docker-compose down

If you want to delete the information saved on docker volumes you can use docker-compose down -v

The django admin site of the project can be accessed at localhost:8010/admin

By default, the development configuration creates a superuser with the following credentials:

Username: admin
Password: admin

The project is Heroku ready with Build Manifest deploy approach. You should follow those steps to deploy it as heroku app.

Keep in mind Docker-based deployments are limited to the same constraints that Git-based deployments are. For example, persistent volumes are not supported since the file system is ephemeral and web processes only support HTTP(S) requests.

The production environment requires certain configuration before deploying the docker image, such as the database, and the AWS settings.

The system is configured using environment variables. The following is the list of environment variables that are required or optional before deploying the system:

As expected in a Twelve Factors App the following services needs to be configured using environment variables as well:

When having all the prerequisites, and you have logged in with your Heroku client, clone the repository in the server, then deploy the containers with the commands:

heroku update beta
heroku plugins:install @heroku-cli/plugin-manifest

Then create your app using the --manifest flag. The stack of the app will automatically be set to container:

heroku create app-name --manifest

Do not forget change app-name for your app name

Commit your heroku.yml to git:

git add heroku.yml
git commit -m "Add heroku build manifest"

Push the code:

git push heroku master

Please check the Known issues and limitations for this approach

Finally, your application can be accessed from the Heroku dashboard! 🚀