django-misc/README.md

Reusable templates and skeleton-structures for Django-based projects

These are part experiment, part productivity stuff that aims to "automate" the more boring parts of a Django development cycle. The directories are complete apps ready to be plugged in and styled to taste (no CSS, JS etc included).

To use it within a new project, do:

# clone this repo:
git clone https://notabug.org/kzimmermann/django-misc

# assuming django is installed with proper environment, create a new project:
django-admin startproject mysupercoolsite

# copy an app from the repo into your project 
cp -r django-misc/blog mysupercoolsite

# edit your settings under INSTALLED_APPS to register the app:
vim mysupervoolsite/mysupercoolsite/settings.py

The app will automatically register itself in the admin site, so you can create your models' instances through it.

This repo does not ship with a "base" template, but rather a group of subtemplates that can be plugged into one of your liking. This should make integration with already-existing projects much faster.

Apps included

• Blog: a generic blogging engine that can allow for public comments. Probably not the best engine around, but still usable nonetheless. Depends on Markdown to render the content properly, which you can install like this pip install markdown. Cannot upload images to posts yet.
• Tasks: a project management aplication, complete with task tracking, issue/risk management and status reporting. Work is done completely on the admin site.

License

Copyright 2017 Klaus Zimmermann - released under the terms of the GNU GPL v3 (see LICENSE)