Getting Started¶
Installation¶
You can get stable version of Django Suit by using pip or easy_install:
pip install django-suit==0.2.26
You will need to add the
'suit'
application to theINSTALLED_APPS
setting of your Django projectsettings.py
file.:INSTALLED_APPS = ( ... 'suit', 'django.contrib.admin', )
Important
'suit'
must be added before'django.contrib.admin'
and if you are using third-party apps with special admin support (like django-cms) you also need to add'suit'
before'cms'
.
For Django < 1.9: You need to add
'django.core.context_processors.request'
toTEMPLATE_CONTEXT_PROCESSORS
setting in your Django projectsettings.py
file.:from django.conf.global_settings import TEMPLATE_CONTEXT_PROCESSORS as TCP TEMPLATE_CONTEXT_PROCESSORS = TCP + ( 'django.core.context_processors.request', )
For Django >= 1.9 or with new Django ``TEMPLATES`` setting: Make sure you have
django.template.context_processors.request
in yourTEMPLATES
OPTIONS
context_processors
setting in your Django projectsettings.py
file.:TEMPLATES = [ { 'BACKEND': 'django.template.backends.django.DjangoTemplates', 'DIRS': [], 'APP_DIRS': True, 'OPTIONS': { 'context_processors': [ 'django.template.context_processors.debug', 'django.template.context_processors.request', # Make sure you have this line 'django.contrib.auth.context_processors.auth', 'django.contrib.messages.context_processors.messages', ], }, }, ]Note: This is required to handle left side menu. If by some reason you removed original Django Suit
menu.html
, you can skip this.
Deployment¶
Deployment with Django Suit should not be different than any other Django application. If you have problems with deployment on production, read Django docs on wsgi first.
Note
If you deploy your project with Apache or Debug=False
don’t forget to run ./manage.py collectstatic
Develop branch¶
Develop branch is considered as release candidate version. Check commits and changelog of develop branch first, before installing develop version. It is quite stable and always tested, but can contain some flaws or behaviour changes too. To install latest develop version use:
pip uninstall django-suit
pip install https://github.com/darklow/django-suit/tarball/develop
v2-dev branch¶
v2-dev branch is a complete rewrite using Bootstrap v4. It is still in development and this documentation doesn’t match v2-dev. Read more about v2 here. To install latest v2 version use:
pip uninstall django-suit
pip install https://github.com/darklow/django-suit/tarball/v2