Welcome to Cookiecutter Django Minimal’s documentation!

Contents:

Tutorial

  1. Install Cookiecutter.

  2. Create project template.

cookiecutter https://github.com/stefanitsky/cookiecutter-django-minimal.git
project_name [My Project]: My Personal Blog
project_slug [my_personal_blog]: blog
author [Alexandr Stefanitsky-Mozdor]:
email [stefanitsky.mozdor@gmail.com]:
version [0.1.0]:
timezone [UTC]: Europe/Moscow

  1. Open created folder.

cd blog

  1. Run project via ready-to-use docker and make.

make development-up

  1. Open http://0.0.0.0:8000/.

Features

Project structure

The project structure is similar to RoR project structure, where application is in one folder. Templates, static files, fixtures, media - everything is configured to be stored in the folder with the main application.

Bump versions

The project has a configured version controller - bump2version

Usage:

bump2version [options] part [file]

It changes the version for the project, including sentry.

Makefile

Makefile contains many convenient and useful commands. You can get a complete list of commands by typing make help.

cookiecutter-django-minimal

A cookiecutter template for creating minimal Django apps, with configured settings for multiple environments.

Highlights

  • Minimal setup: only the most important.

  • Preconfigured settings & compose files for multiple environments.

  • Configuration as in the RoR application for main app folder.

Indices and tables