Skip to content

josemarimanio/django-adminlte2-templates

Repository files navigation

PyPi

Travis CI

Documentation

CodeFactor Grade

Codecov

License - MIT

AdminLTE 2 templates for Django

django-adminlte2-templates provides templates to easily integrate AdminLTE 2 to your Django projects. Also included in the package is an optional AdminLTE-based theme for Django Admin.

For more information, please see the documentation online. Alternatively, the documentation is also available in the docs directory of the project.

This Django module assumes that you have prior experience with AdminLTE 2. Please check the AdminLTE 2 documentation online for your reference.

For a live version of the example project of this app, please check https://djangoadminlte2templates.pythonanywhere.com/.

Requirements

  • Python (2.7, 3.4, 3.5, 3.6, 3.7, 3.8)
  • Django (1.11, 2.0, 2.1, 2.2, 3.0, 3.1)

Installation

Installing using pip:

pip install django-adminlte2-templates

Add adminlte2_templates to INSTALLED_APPS:

INSTALLED_APPS = [
    'adminlte2_templates',
    'adminlte2_admin',  # Optional Django Admin theme
    ..
]

Add adminlte2_templates.context_processors.template to context_processors:

TEMPLATES = [
        ...
        'OPTIONS': {
            'context_processors': [
                ...
                'adminlte2_templates.context_processors.template',
            ],
        ...
]

This module provides static files for the following client-side libraries out-of-the-box:

  • AdminLTE 2.4.18 (static/adminlte2/adminlte-2.4.18)
  • Bootstrap 3.4.1 (static/adminlte2/bootstrap-3.4.1)
  • DataTables 1.10.21 (static/adminlte2/datatables-1.10.21)
  • Font Awesome 4.7.0 (static/adminlte2/fontawesome-4.7.0)
  • HTML5Shiv 3.7.3 (static/adminlte2/html5shiv-3.7.3)
  • jQuery 3.5.1 (static/adminlte2/jquery-3.5.1)
  • Respond.js 1.4.2 (static/adminlte2/respond-1.4.2)
  • Select2 4.0.13 (static/adminlte2/select2-4.0.13)

Quickstart

Head to the Quickstart section of the documentation online for an example usage of django-adminlte2-templates.

Also, an example Django project example_project is included in the module for your reference.