|
| 1 | +--- |
| 2 | +title: Django AdminLTE - Open-Source UI LIbrary |
| 3 | +sidebar_label: Django AdminLTE |
| 4 | +--- |
| 5 | + |
| 6 | +# [Django AdminLTE Theme](https://appseed.us/product/adminlte/django/) |
| 7 | + |
| 8 | +<SubHeading> Open-source Library for Django admin section styled with AdminLTE Design</SubHeading> |
| 9 | + |
| 10 | +Modern template for **Django** that covers `Admin Section`, all authentication pages (registration included) crafted on top of [AdminLTE](https://appseed.us/product/adminlte/django/), |
| 11 | +an iconic `Bootstrap` design from ColorLib. |
| 12 | + |
| 13 | + |
| 14 | +**Links & Resources** |
| 15 | + |
| 16 | +- [Django AdminLTE](/products/django-dashboards/adminlte/) - `Product` that uses the library |
| 17 | + - `Features`: Fully-configured, `CI/CD` via Render |
| 18 | +- UI Kit: `AdminLTE` by `ColorLib` |
| 19 | +- **Sections Covered**: |
| 20 | + - `Admin Section`, reserved for `superusers` |
| 21 | + - `All pages` managed by `Django.contrib.AUTH` |
| 22 | + - `Registration` page |
| 23 | + - `Misc pages`: colors, icons, typography, blank-page |
| 24 | + |
| 25 | + |
| 26 | + |
| 27 | + |
| 28 | + |
| 29 | +## How to use it |
| 30 | + |
| 31 | +> **Install the package** via `PIP` |
| 32 | +
|
| 33 | +```bash |
| 34 | +$ pip install django-admin-adminlte |
| 35 | +// OR |
| 36 | +$ pip install git+https://github.com/app-generator/django-admin-adminlte.git |
| 37 | +``` |
| 38 | + |
| 39 | +> Add `admin_adminlte` application to the `INSTALLED_APPS` setting of your Django project `settings.py` file (note it should be before `django.contrib.admin`): |
| 40 | +
|
| 41 | +```python |
| 42 | + INSTALLED_APPS = ( |
| 43 | + ... |
| 44 | + 'admin_adminlte.apps.AdminAdminlteConfig', |
| 45 | + 'django.contrib.admin', |
| 46 | + ) |
| 47 | +``` |
| 48 | + |
| 49 | + |
| 50 | +> Add `LOGIN_REDIRECT_URL` and `EMAIL_BACKEND` of your Django project `settings.py` file: |
| 51 | +
|
| 52 | +```python |
| 53 | + LOGIN_REDIRECT_URL = '/' |
| 54 | + # EMAIL_BACKEND = 'django.core.mail.backends.smtp.EmailBackend' |
| 55 | + EMAIL_BACKEND = 'django.core.mail.backends.console.EmailBackend' |
| 56 | +``` |
| 57 | + |
| 58 | + |
| 59 | +> Add `admin_adminlte` urls in your Django Project `urls.py` file |
| 60 | +
|
| 61 | +```python |
| 62 | + from django.urls import path, include |
| 63 | + |
| 64 | + urlpatterns = [ |
| 65 | + ... |
| 66 | + path('', include('admin_adminlte.urls')), |
| 67 | + ] |
| 68 | +``` |
| 69 | + |
| 70 | + |
| 71 | +> **Collect static** if you are in `production environment`: |
| 72 | +
|
| 73 | +```bash |
| 74 | +$ python manage.py collectstatic |
| 75 | +``` |
| 76 | + |
| 77 | +> **Start the app** |
| 78 | +
|
| 79 | +```bash |
| 80 | +$ # Set up the database |
| 81 | +$ python manage.py makemigrations |
| 82 | +$ python manage.py migrate |
| 83 | +$ |
| 84 | +$ # Create the superuser |
| 85 | +$ python manage.py createsuperuser |
| 86 | +$ |
| 87 | +$ # Start the application (development mode) |
| 88 | +$ python manage.py runserver # default port 8000 |
| 89 | +``` |
| 90 | + |
| 91 | +Access the `admin` section in the browser: `http://127.0.0.1:8000/` |
| 92 | + |
| 93 | + |
| 94 | + |
| 95 | +## How to Customize |
| 96 | + |
| 97 | +When a template file is loaded, `Django` scans all template directories starting from the ones defined by the user, and returns the first match or an error in case the template is not found. |
| 98 | +The theme used to style this starter provides the following files: |
| 99 | + |
| 100 | +```bash |
| 101 | +# This exists in ENV: LIB/admin_adminlte |
| 102 | +< UI_LIBRARY_ROOT > |
| 103 | + | |
| 104 | + |-- templates/ # Root Templates Folder |
| 105 | + | | |
| 106 | + | |-- accounts/ |
| 107 | + | | |-- login.html # Sign IN Page |
| 108 | + | | |-- register.html # Sign UP Page |
| 109 | + | | |
| 110 | + | |-- includes/ |
| 111 | + | | |-- footer.html # Footer component |
| 112 | + | | |-- sidebar.html # Sidebar component |
| 113 | + | | |-- navigation.html # Navigation Bar |
| 114 | + | | |-- scripts.html # Scripts Component |
| 115 | + | | |
| 116 | + | |-- layouts/ |
| 117 | + | | |-- base.html # Masterpage |
| 118 | + | | |-- base-auth.html # Masterpage for Auth Pages |
| 119 | + | | |
| 120 | + | |-- pages/ |
| 121 | + | |-- index.html # Dashboard Page |
| 122 | + | |-- calendar.html # Profile Page |
| 123 | + | |-- *.html # All other pages |
| 124 | + | |
| 125 | + |-- ************************************************************************ |
| 126 | +``` |
| 127 | + |
| 128 | +When the project requires customization, we need to copy the original file that needs an update (from the virtual environment) and place it in the template folder using the same path. |
| 129 | + |
| 130 | +For instance, if we want to customize the `footer.html` these are the steps: |
| 131 | + |
| 132 | +- `Step 1`: create the `templates` DIRECTORY inside your app |
| 133 | +- `Step 2`: configure the project to use this new template directory |
| 134 | + - Edit `settings.py` TEMPLATES section |
| 135 | +- `Step 3`: copy the `footer.html` from the original location (inside your ENV) and save it to the `YOUR_APP/templates` DIR |
| 136 | + - Source PATH: `<YOUR_ENV>/LIB/admin_adminlte/templates/includes/footer.html` |
| 137 | + - Destination PATH: `YOUR_APP/templates/includes/footer.html` |
| 138 | +- Edit the `footer.html` (Destination PATH) |
| 139 | + |
| 140 | +At this point, the default version of the `footer.html` shipped in the library is ignored by Django. |
| 141 | + |
| 142 | +In a similar way, all other files and components can be customized easily. |
| 143 | + |
| 144 | + |
| 145 | +## Resources |
| 146 | + |
| 147 | +- 👉 [Django AdminLTE](https://appseed.us/product/adminlte/django/) - `Product` that uses the library (fully configured) |
| 148 | +- 👉 Free [Support](https://appseed.us/support/) via Email & Discord |
0 commit comments