https://github.com/rdegges/django-skel

A modern Django (1.5) project skeleton.
https://github.com/rdegges/django-skel

Last synced: 3 months ago
JSON representation

A modern Django (1.5) project skeleton.

• Host: GitHub
• URL: https://github.com/rdegges/django-skel
• Owner: rdegges
• Archived: true
• Created: 2011-11-10T01:06:01.000Z (almost 13 years ago)
• Default Branch: master
• Last Pushed: 2014-01-30T20:41:19.000Z (almost 11 years ago)
• Last Synced: 2024-07-25T04:35:49.168Z (3 months ago)
• Language: Python
• Homepage: http://django-skel.rtfd.org/
• Size: 964 KB
• Stars: 518
• Watchers: 35
• Forks: 106
• Open Issues: 6
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• starred-awesome - django-skel - A modern Django (1.5) project skeleton. (Python)

README

        
django-skel

===========

A modern Django (1.5) project skeleton.

![A fancy Django project skeleton](https://github.com/rdegges/django-skel/raw/master/docs/source/_static/skel.jpg)

Meta

====

* author: Randall Degges

* email:  [email protected]

* status: maintained, in development

* notes:  Have feedback? Please send me an email. This project is still in its

          infancy, and will be changing rapidly.

Purpose

=======

For background, see: http://rdegges.com/deploying-django

Essentially--deploying Django projects is hard. There are lots of things you

need to take into consideration. Being a Django user for years, I believe I've

found some extremely useful patterns to help manage all sorts of Django sites

(from the very smallest apps, to the largest).

This project is meant to be a boilerplate project for starting development. It

is heavily opinionated in terms of services and tools--but I think the tradeoff

is worthwhile.

Docs

====

The full project documentation is hosted at RTFD: http://django-skel.rtfd.org/.

They are continuously updated to reflect changes and information about the

project, so be sure to read them before using this boilerplate.

Install

=======

django-skel currently supports Django 1.5. To create a new django-skel base

project, run the following command (this assumes you have Django 1.5 installed

already):

    $ django-admin.py startproject --template=https://github.com/rdegges/django-skel/zipball/master woot

    $ heroku config:add DJANGO_SETTINGS_MODULE=myproject.settings.prod

Where ``woot`` is the name of the project you'd like to create.

This is possible because Django 1.5's ``startproject`` command allows you to

fetch a project template over HTTP (which is what we're doing here).

While not strictly required, it is also recommended to do

     $ heroku config:add SECRET_KEY=putsomethingfairlycomplexhere

The production settings pull SECRET_KEY from environment but fallbacks

to a value which is generated mainly for development environment.

This setup allows you to easily keep your site in a public repo if you so 

wish without causing opening a route to attack your Django passwords.