Django Palette Docs

Welcome to Django Palette documentation!

django-palette is a powerful Django admin interface framework with beautiful Bootstrap styling, reusable components, and custom template tags for building elegant admin pages.

Table of Contents

Getting Started

• Getting Started
  • What is Django Palette?
  • Who is it for?
  • Next Steps
  • Key Concepts
  • Features Highlights
  • Need Help?
• Installation
  • Prerequisites
  • Step 1: Install the Package
  • Step 2: Add to INSTALLED_APPS
  • Step 3: Configure URLs (Optional)
  • Step 4: Run Migrations
  • Step 5: Collect Static Files
  • Step 6: Create a Superuser (if needed)
  • Step 7: Test the Installation
  • Troubleshooting
  • Upgrade from Previous Version
  • Next Steps
  • Need Help?
• Quick Start
  • Installation (1 minute)
  • Creating a Component (2 minutes)
  • Using the Component (2 minutes)
  • What’s Next?
  • Key Concepts
  • Example: Creating a Dashboard
  • Ready?

User Guide

• Features
  • Beautiful Bootstrap Admin Interface
  • Responsive Design
  • Reusable Components
  • Component Slots and Overrides
  • Template Tags
  • Enhanced Admin Pages
  • Django Admin Integration
  • Sidebar Navigation
  • Drag-and-Drop File Upload
  • Grid/List Toggle Views
  • Built-in Filters
  • Zero Breaking Changes
  • Static Files Included
  • Customization
• Template Tags
  • Loading the Template Tag Library
  • palette_component
  • palette_block
  • palette_ui
  • palette_override
  • Complete Example
  • Tips & Tricks
  • Common Patterns
• Components
  • What is a Component?
  • Why Use Components?
  • Creating Your First Component
  • Component Design Patterns
  • Best Practices
  • Organization
  • Advanced Techniques
  • Real-World Examples

Examples

• Examples

Quick Links

• GitHub Repository

• PyPI Package

• Issue Tracker

Features

• 🎨 Beautiful Bootstrap Admin Interface - Modern, responsive admin templates with Bootstrap 5 styling

• 📱 Responsive Design - Works seamlessly on desktop, tablet, and mobile devices

• 🧩 Reusable Components - Build custom UI components with the palette_component tag

• 🔄 Component Slots - Define and override content blocks within components using palette_block and palette_override

• 🎯 Template Tags - Custom tags for rendering and managing components with context variables

• 📊 Enhanced Admin Pages - Pre-styled templates for change_list, change_form, login, password change, and delete confirmation

• 🔐 Django Admin Integration - Full compatibility with Django’s permissions and admin system

• 📁 Sidebar Navigation - Collapsible sidebar with app and model navigation

• 🎨 Drag-and-drop File Upload - Modern file upload interface with image preview

• 🔍 Grid/List Toggle Views - Multiple view modes for displaying model lists

• ⚡ Zero Breaking Changes - Works alongside existing Django admin setup

Installation

Install django-palette using pip:

pip install dj-palette

Then add it to your INSTALLED_APPS in settings.py:

INSTALLED_APPS = [
    'dj_palette',
    'dj_palette.palette_admin',
    'django.contrib.admin',
    ...
]

For detailed setup instructions, see Installation.

Support

• Documentation: https://dj-palette.readthedocs.io

• GitHub Issues: https://github.com/ogofe/dj_palette/issues

• Email: 7thogofe@gmail.com

License

MIT License © 2025 Joel O. Tanko