django-admin-interface/README.md

4.0 KiB

Build Status codecov PyPI version Py versions License

django-admin-interface

django-admin-interface is a modern responsive flat admin interface customizable by the admin itself.

Features

  • Beautiful default django-theme
  • Themes management and customization (you can customize admin title, logo and colors)
  • Responsive
  • List filter dropdown (optional)
  • NEW Related modal (instead of the old popup window, optional)
  • Style optimizations for: django-ckeditor, django-modeltranslation, sorl-thumbnail

Requirements

  • Python 2.7, 3.4, 3.5, 3.6
  • Django 1.7, 1.8, 1.9, 1.10, 1.11

Installation

  • Run pip install django-admin-interface
  • Add admin_interface, flat_responsive, flat and colorfield to settings.INSTALLED_APPS before django.contrib.admin
INSTALLED_APPS = (
    #...
    'admin_interface',
    'flat_responsive',
    'flat', #if django version < 1.9
    'colorfield',
    #...
    'django.contrib.admin',
    #...
)
  • Run python manage.py migrate
  • Run python manage.py collectstatic
  • Restart your application server

Upgrade

  • Run pip install django-admin-interface --upgrade
  • Run python manage.py migrate (add --fake-initial if you are upgrading from 0.1.0 version)
  • Run python manage.py collectstatic --clear
  • Restart your application server

Optional themes

This package ships with optional themes as fixtures, they can be installed using the loaddata admin command python manage.py loaddata [fixture_theme_name].

  • Original Django Admin: restore the default colours of the original admin. Fixture name: admin_theme_default

Add more

You can add a theme you've created through the admin to this repository by sending us a PR. Here are the steps to follow to add :

  1. Use dumpdata admin command in your project to export your exact theme: python manage.py dumpdata admin_interface.Theme --indent 2 -o admin_theme_mystuff.json --pks=N
  2. Copy the generated json file into the fixtures folder, making sure its name starts with admin_theme_ to avoid clashes with fixtures that might be provided by other third party apps.
  3. Remove the "pk" from the fixture and make sure the active field is set to false.
  4. Edit the section above to document your theme.

Screenshots

Admin login

django-admin-interface_login

Admin dashboard

django-admin-interface_dashboard

Admin themes management

django-admin-interface_themes_management

Admin theme customization

django-admin-interface_theme_customization

Thanks

License

Released under MIT License.