Commits

Olexiy Strashko committed 9c340c7

Added readme

Comments (0)

Files changed (1)

+=======================
+Django template project
+=======================
+
+Using django-template-project you will minimize bunch of routine tasks, required for every new project:
+
+- make directory structure
+- configure settings
+- make web skeleton (styles + html templates)
+
+Project came from our Django development experience. We are using it, so, maybe it will be useful for you.
+
+Any ideas, improvements or critics are very welcome!
+
+-----------------
+Features
+-----------------
+
+Settings:
+
+1. Separated settings per each application, see settings/apps package
+2. Deployment and local settings profiles
+
+Bundled **Main** application:
+
+1. Basic **main** application with standard structure (templates, migrations, fixtures, etc);
+2. Standard Django 1.3 static files directories (css, img, js);
+ 
+Templates:
+
+1. Basic layout templates, including content, header, footer, and menu. You can extend from layout/base.html;
+2. Support for meta tags, title, css and javascript extensions, when extending from base.html;
+3. 404 and 500 templates;
+
+CSS:
+
+1. CSS reset;
+2. Basic layout styles;
+3. Rich content styles;
+
+JavaScript:
+
+1. Enabled jQuery (we've made it as ext django app);
+
+Static files:
+1. We use Django 1.3 static files, as its a rocket feature!
+2. Configured **static **and **media **roots
+
+Utility scripts (win):
+
+1. I18n & localization (make and compile messages)
+2. Dump, load, init DB
+3. South migrations
+
+-------------
+Structure
+-------------
++ media - *media files (content uploaded by users)*
++ source - *media files (content uploaded by users)*
+
+    apps
+    conf
+    db
+    lib
+    scripts
+    settings
+
++ static - *static files (css, js, img)*
+requirements.txt - *Virtualenv/pip*
+-------------
+Requirements
+-------------
+
+See requirements.txt in root folder:
+
+- Django 1.3
+- South
+
+-------------
+Installation
+-------------
+1. Clone it
+2. Disconnect from Mercurial
+3. Run
+4. Extend it
+
+-------------
+Change log
+-------------
+
+2011-10
+^^^^^^^
+
+Made by `WebRiders <http://www.webriders.com.ua>`_
+
+
+
+-------------
+TODO
+-------------
+- enable Sigurd