Files @ ab300f858903
Branch filter:

Location: majic-django-templates/docs/about.rst

ab300f858903 2.7 KiB text/prs.fallenstein.rst Show Annotation Show as Raw Download as Raw
branko
MDT-1: Use better pathfinding for development environment when locating the sqlite3 database. Set a saner default for redirect after login (redirect to 'index' view, whatever it may be).
About Majic Django Templates
============================

*Majic Django Templates* is a set of project and application templates
(skeletons) for Django, which can be used in combination with ``django-admin``
commands ``startproject`` and ``startapp``. This is *not* to be confused with
the templates used within Django projects and applications themselves.

These templates allow you to easily create some basic boilerplate for Django
projects and applications, with some added flexibility and batteries for
deployments in multiple environments etc.


Why were these templates created?
---------------------------------

I wanted to have a set of templates I could use as a common base for deploying
Django projects on my own servers. There was already a couple of templates out
there, but some were not perfectly aligned with my needs, and I wanted to have a
better control of with personalised templates.

In particular, the project template was heavily influced by the book `Two Scoops
of Django <http://twoscoopspress.org/>`_ (at the time I was using the book
written for Django 1.5.x series), with one main difference - I did not like
having the database password and secret key supplied as values of environment
variables. I wanted to have those as part of a *Python* file instead.

So, this was the beginning of my own project template. I kind of had one Django
website deployed using this (my wiki), and the template itself was rather poorly
documented. Heck, I had to traceback my steps every time I wanted to use it -
which was also not very often :).

Some time later, a colleague of mine and me decided to start working on a web
project of our own. We decided to use Django. My colleague had no previous
experience with it (although, unlike me, he is a seasoned developer), so the
decision was made for me to create a complete project template for him as a
starting point (during that time he concentrated on learning Python/Django).

At this time I tried again to use my previous template attempt, and was
semi-successful (after all, the initial template was designed for Django 1.5).

I started working again, this time on a *set* of templates which would include
both project and application templates, and which would also have proper
documentation to help both him and me get started.

What you see before you know is the fruit of that labour. If anyone decides to
use it, I sure hope it will prove useful. If not, oh well, at leat it works for
me :) All criticism is welcome too!


Features
--------

Majic Django Templates implement the following:

* One project template, with support for having multiple environment
  configurations (development, testing, production), where each environment
  shares a common project configuration, and then adds its own specifics.