Welcome to Django Naqsh’s documentation!

A Cookiecutter template for Django.

Contents:

• Project Generation Options
• Getting Up and Running Locally
  • Setting Up Development Environment
  • Setup Email Backend
  • Celery
  • Summary
• Getting Up and Running Locally With Docker
  • Prerequisites
  • Build the Stack
  • Run the Stack
  • Execute Management Commands
  • (Optionally) Designate your Docker Development Server IP
  • Configuring the Environment
  • Tips & Tricks
• Settings
• Linters
  • flake8
  • pylint
  • pycodestyle
• Testing
  • Pytest
  • Coverage
• Document
  • Generate API documentation
• Deployment on PythonAnywhere
  • Overview
  • Getting your code and dependencies installed on PythonAnywhere
  • Setting environment variables in the console
  • Database setup:
  • Configure the PythonAnywhere Web Tab
  • Optional: static files
  • Future deployments
• Deployment on Heroku
  • Commands to run
  • Optional actions
  • About Heroku & Docker
• 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
  • (Optional) Postgres Data Volume Modifications
  • Building & Running Production Stack
  • Example: Supervisor
• PostgreSQL Backups with Docker
  • Prerequisites
  • Creating a Backup
  • Viewing the Existing Backups
  • Copying Backups Locally
  • Restoring from the Existing Backup
  • Backup to Amazon S3
• FAQ
  • Why is there a django.contrib.sites directory in Django Naqsh?
  • 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
  • Others

Indices and tables

• Index
• Search Page