Django Starter with CustomUser, Django Documentation Generator, DEV-PROD settings, pipenv, and Heroku Procfile

• NOTE: Author is using PowerShell for this guide.

Features

• Custom user model.
• Django admin documentation generator.
• Separate DEV and PROD settings.
• Pipfile included.
• Heroku Procfile included.

Assumptions

• User has functioning Python 3.11 installation.
• User has functioning pipenv installation.
• User has functioning git installation.
• User is familiar with how to use terminal commands.
• User has Heroku account.
• User has Heroku CLI installed.

WARNING:

• Deployment checklist - docs.djangoproject.com
  • This template has Django SECRET_KEY exposed in development settings files. It is important to create your own separate SECRET_KEY for development and production and keep them out of the codebase. This template has SECRET_KEY exposed in order to get the user up and running quickly.

Process

1. Create Repository from DjangoCustomUserStarter-heroku Template
2. Run Application Locally
3. Create Heroku Application Server Instance
4. Provision Database Server Instance
5. Add DJANGO_SETTINGS_MODULE to Config Vars
6. Add Django SECRET_KEY to Config Vars
7. Add Database Settings to Config Vars
8. Modify ALLOWED_HOSTS
9. Push to Heroku and Create Superuser

Excellent resources, this project wouldn't have been possible without these

• CustomUser method: Django Best Practices: Custom User Model - Will Vincent - learndjango.com
• Docutils: The Django admin documentation generator - docs.djangoproject.com
• DEV and PROD settings: Configuring Django Settings for Production - thinkster.io

Other Documentation

• Pipenv & Virtual Environments
  • User installation:
    • pip install --user pipenv
  • Global installation:
    • pip install pipenv

Links to this project's pages

• DjangoStarter-heroku Repository