Django Boilerplate

screenshot of Django Boilerplate

Basic Django boilerplate designed for easier deployment

Overview

Django Boilerplate is a tested Django project template designed to provide a solid foundation for developing web applications using Python 3. It includes features such as environment variable configuration, a basic health check endpoint, and configuration options for code linting and formatting. The project also utilizes the Circus deployment tool for managing processes and ensures a complete separation of runtime files for easier maintenance.

Features

  • Environment variables: Allows for easy configuration of the application using environment variables or a .env file.
  • Basic health check endpoint: Includes a health check endpoint to ensure the application is running properly.
  • Code linting and formatting: Configurations are provided for flake8, pydocstyle, and editorconfig to maintain consistent code style.
  • Circus deployment: Utilizes the Circus tool for managing processes and ensuring smooth deployment.
  • Complete separation of runtime files: Runtime files such as static/media files, logs, and file-based cache are kept separate for easier maintenance and organization.
  • Basic Dockerfile: Includes a Dockerfile for Docker-based deployment, with options to remove unnecessary components to reduce container size.
  • Requirements: Requires Python 3.5+ for installation and deployment.

Summary

Django Boilerplate is a well-tested Django project template with a range of useful features. It provides an easy way to configure the application using environment variables, includes a basic health check endpoint, and offers configurations for code linting and formatting. The project also utilizes Circus deployment for process management and ensures a clean separation of runtime files. With a basic Dockerfile included, deploying the application becomes even easier. Overall, Django Boilerplate is a solid choice for starting a Django web application project.