Django Template

A simple Django template.

Table of Contents

• Prerequisites
• Installation
• Development
• Available Commands
• Security Features

Prerequisites

Before you begin, ensure you have the following installed:

• Python 3.12
• uv (Python package manager)
• just (command runner)

Installation

1. Clone the repository:

   git clone https://github.com/knowsuchagency/django-template.git
   cd django-template
   

2. Initialize the development environment:

   just init
   

   This will create a virtual environment, install dependencies, and set up the .env file.

Development

To run the development server:

just runserver

Available Commands

Use just <command> to run the following commands:

• list: Show all available commands
• format: Format and fix code using ruff and prettier
• runserver: Run Django development server
• makemigrations: Create new database migrations
• migrate: Apply database migrations
• flush: Flush the database
• createsuperuser: Create a Django superuser
• collectstatic: Collect static files

For a full list of commands, run just list.

Security Features

Wildcard CSRF Trusted Origins

This template includes a custom CSRF middleware that supports wildcard patterns in the CSRF_TRUSTED_ORIGINS setting. This allows you to trust multiple subdomains without having to list each one individually.

Example configuration in .env:

CSRF_TRUSTED_ORIGINS=https://*.example.com,https://example.com,http://localhost:8000

This will trust:

• Any subdomain of example.com (e.g., app.example.com, api.example.com)
• The root domain example.com
• localhost:8000

To use this feature, the custom middleware is already configured in the project's settings.