Home

Django Production Boilerplate Wiki

This wiki explains how to run, extend, and operate the boilerplate. It serves developers learning production Django and experienced teams evaluating its infrastructure decisions.

Start Here

New to Django or this repository:

1. Follow the Quick Start.
2. Build one complete feature with Extending the Boilerplate.
3. Learn how Email and Caching are selected through environment configuration.
4. Read Deployment before exposing the application publicly.

Already comfortable with Django:

1. Review Architecture for boundaries and deliberate omissions.
2. Check Deployment for container and native-host topology.
3. Review Cache and Email for backend contracts and failure behavior.
4. Use the Roadmap to decide what belongs in the boilerplate versus an application.

Core Principle

The boilerplate owns infrastructure defaults, not product architecture. Django's native interfaces remain the boundary for storage, cache, email, authentication, and application modules wherever practical.

This keeps local and production providers replaceable without spreading environment checks through feature code.

Documentation Map

Goal	Page
Run Django locally	Quick Start
Understand project boundaries	Architecture
Add a complete module	Extending the Boilerplate
Configure caching or Redis	Cache
Configure Mailpit or SMTP	Email
Deploy and operate the application	Deployment
Review planned additions	Roadmap
Review current release changes	Release Notes

Source of Truth

Wiki pages are published from Markdown in the repository after changes reach main. Contribute documentation through normal pull requests so documentation changes receive the same review as code.