Welcome to Cookiecutter Django’s documentation!

Powered by Cookiecutter, Cookiecutter Django is a project template for jumpstarting production-ready Django projects. The template offers a number of generation options, we invite you to check the dedicated page to learn more about each of them.

Getting Started

• Project Generation Options
• Settings
  • Other Environment Settings

Local Development

• Getting Up and Running Locally
  • Setting Up Development Environment
  • Creating Your First Django App
  • Setup Email Backend
  • Celery
  • Using Webpack or Gulp
  • Summary
• Getting Up and Running Locally With Docker
  • Prerequisites
  • Before Getting Started
  • Build the Stack
  • Run the Stack
  • Execute Management Commands
  • (Optionally) Designate your Docker Development Server IP
  • Configuring the Environment
  • Tips & Tricks
  • (Optionally) Developing locally with HTTPS

Deployment

• Deployment on PythonAnywhere
  • Overview
  • Getting your code and dependencies installed on PythonAnywhere
  • Setting environment variables in the console
  • Database setup
  • Redis
  • Configure the PythonAnywhere Web Tab
  • Optional: static files
  • Future deployments
• Deployment on Heroku
  • Script
  • Notes
  • Optional actions
• Deployment with Docker
  • Prerequisites
  • Understanding the Docker Compose Setup
  • Configuring the Stack
  • Optional: Use AWS IAM Role for EC2 instance
  • HTTPS is On by Default
  • Webpack without Whitenoise limitation
  • (Optional) Postgres Data Volume Modifications
  • Building & Running Production Stack
  • Example: Supervisor
  • Media files without cloud provider

Guides

• PostgreSQL Backups with Docker
  • Prerequisites
  • Creating a Backup
  • Viewing the Existing Backups
  • Copying Backups Locally
  • Restoring from the Existing Backup
  • Backup to Amazon S3
  • Remove Backup
  • Upgrading PostgreSQL
• Linters
  • ruff
• Testing
  • Pytest
  • Coverage
• Document
  • Generate API documentation
  • Setting up ReadTheDocs
• Websocket
  • Usage

Help

• FAQ
  • Why is there a django.contrib.sites directory in Cookiecutter Django?
  • Why aren’t you using just one configuration file (12-Factor App)
  • Why doesn’t this follow the layout from Two Scoops of Django?
• Troubleshooting
  • Server Error on sign-up/log-in
  • Docker: Postgres authentication failed
  • Variable is not set. Defaulting to a blank string
  • Others

About

• How to Contribute
  • General considerations
  • Getting started
  • Testing
  • Submitting a pull request
• Maintainer guide
  • Automated updates
  • Automation scripts

Indices and tables

• Index

• Search Page