Overview
Unfold is a Django Admin theme that incorporates common practices for building robust admin areas. It enhances the default Django administration with a new user interface based on the Tailwind CSS framework. Unfold provides features such as a customizable sidebar navigation, support for light and dark mode, configurable options, actions, WYSIWYG support, custom filters, custom dashboard components, tab navigations, customizable color scheme, and compatibility with popular third-party packages. The installation process is minimal and does not require any changes to the default admin configuration.
Features
- Visual: Provides a new user interface based on the Tailwind CSS framework.
- Sidebar: Simplifies the definition of custom sidebar navigation with icons.
- Dark mode: Supports both light and dark mode versions.
- Configuration: Most basic options can be changed in the settings.py file.
- Dependencies: Completely based only on django.contrib.admin.
- Actions: Multiple ways to define actions within different parts of the admin.
- WYSIWYG: Built-in support for a WYSIWYG editor (Trix).
- Custom filters: Provides widgets for filtering numeric and datetime values.
- Dashboard: Custom components for rapid dashboard development.
- Tabs: Define custom tab navigations for models.
- Colors: Possibility to override the default color scheme.
- Third party packages: Default support for multiple popular applications.
- Environment label: Distinguish between environments by displaying a label.
Installation
To install the Unfold Django Admin Theme, follow these steps:
- Put the Unfold application at the beginning of INSTALLED_APPS in the settings.py file.
- No changes are required in the default admin configuration in urls.py.
- Ensure that admin classes inherit from the custom ModelAdmin available in unfold.admin.
In case you need the installation command, here are the versions for pip and poetry:
pip install unfold-admin
poetry add unfold-admin
After installation, you can customize the admin configuration as per your requirements.
Summary
Unfold is a powerful Django Admin theme that enhances the default Django administration with a new user interface, customizable features, and support for popular third-party packages. It simplifies the development of full-fledged admin areas by incorporating common practices and providing various customization options. With its minimal installation process and comprehensive documentation, Unfold is a go-to choice for developers looking to supercharge their Django admin projects.