Django Suit documentation

Django Suit - Modern theme for Django admin interface.

About

Django Suit is alternative theme/skin/extension for Django admin app (administration interface).

Licence

Resources

Contents:

Install

To install Django Suit

  1. Install Django Suit v2-dev using pip or easy_install:

    pip install https://github.com/darklow/django-suit/tarball/v2

  2. Create SuitConfig class and add it to the INSTALLED_APPS before django.contrib.admin app:

# my_project_app/apps.py
from suit.apps import DjangoSuitConfig

class SuitConfig(DjangoSuitConfig):
    layout = 'horizontal'

INSTALLED_APPS = (
    ...
    'my_project_app.apps.SuitConfig',
    'django.contrib.admin',
)

Configure

Documentation is in development.

Currently you can use demo app code as an example for v2: https://github.com/darklow/django-suit/blob/v2/demo/demo/apps.py

v2 live demo: http://v2.djangosuit.com/admin/

v2 demo app code: https://github.com/darklow/django-suit/tree/v2/demo

Contribute

To contribute to Django Suit fork Django Suit on github and clone it locally:

git clone -b v2 git@github.com:YOUR_USERNAME/django-suit.git suit
cd suit

DEV environment

After you forked and cloned repository I suggest you create virtual environment using virtualenv. Feel free to use other virtualenv layout, but here is mine:

# In cloned suit directory create virtualenv
virtualenv env

# Activate virtualenv
source env/bin/activate

# Install Django Suit in editable mode
pip install -e .

# Install dev and demo app requirements
pip install -r requirements-dev.txt
pip install -r demo/requirements.txt

# Run Django Suit demo app
python demo/manage.py runserver 0.0.0.0:8000

SASS compiling

SASS compiling is done in nodejs using gulp tasks and node-sass (uses libsass). Gulp tasks are watching .scss and .html files and automatically reload browser on changes, making development much easier.

# Install dependencies
npm install
bower install

# Run Django Suit demo app
python demo/manage.py runserver 0.0.0.0:8000

# Run gulp tasks and it should automatically open http://localhost:8001/.
# If it didn't, open it manually.
gulp

Documentation

Compile docs:

# Compile docs
make -C docs html

# Clean & compile
make -C docs clean html