Django Theme Pixel
Modern Theme for Django that covers authentication pages (registration included) crafted on top of Pixel BS5, an open-source Bootstrap
design from Themesberg
.
Actively supported by AppSeed via
Discord
.
Links & Resources
-
Django Pixel Bootstrap 5 -
Product page
-
Features
: Fully-configured,CI/CD
via Render
-
- UI Kit:
Pixel Lite
(Bootstrap 5) by Themesberg -
Sections Covered:
-
All pages
managed byDjango.contrib.AUTH
-
Registration
page -
Misc pages
: colors, icons, typography, blank-page
-
Django Pixel Lite
Why - Modern Bootstrap 5 Design
-
Minimal Template
overriding Easy integration
- Fully compatible with
Django.contrib.AUTH
-
Registration
page included
How to use it
Install the package via
PIP
$ pip install django-theme-pixel
// OR
$ pip install git+https://github.com/app-generator/django-theme-pixel.git
Add
theme_pixel
application to theINSTALLED_APPS
setting of your Django projectsettings.py
:
INSTALLED_APPS = [
"django.contrib.admin",
"django.contrib.auth",
"django.contrib.contenttypes",
"django.contrib.sessions",
"django.contrib.messages",
"django.contrib.staticfiles",
'theme_pixel', # <-- NEW
]
Update project
settings.py
file to include (at the end of the file):
LOGIN_REDIRECT_URL = '/'
EMAIL_BACKEND = 'django.core.mail.backends.console.EmailBackend'
Add
theme_pixel
urls in your Django Projecturls.py
file.
from django.urls import path, include # <-- UPD with 'include' directive
urlpatterns = [
...
path('', include('theme_pixel.urls')), # <-- NEW
]
Collect static if you are in
production environment
:
$ python manage.py collectstatic
Start the app
$ # Set up the database
$ python manage.py makemigrations
$ python manage.py migrate
$
$ # Create the superuser
$ python manage.py createsuperuser
$
$ # Start the application (development mode)
$ python manage.py runserver # default port 8000
How to Customize
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.
The theme used to style this starter provides the following files:
# This exists in ENV: LIB/theme_pixel
< UI_LIBRARY_ROOT >
|
|-- templates/ # Root Templates Folder
| |
| |-- accounts/
| | |-- sign-in.html # Sign IN Page
| | |-- sign-up.html # Sign UP Page
| |
| |-- includes/
| | |-- footer.html # Footer component
| | |-- navigation.html # Navigation Bar
| | |-- scripts.html # Scripts Component
| |
| |-- layouts/
| | |-- base.html # Masterpage
| |
| |-- pages/
| |-- index.html # Dashboard Page
| |-- about.html # About Page
| |-- *.html # All other pages
|
|-- ************************************************************************
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.
For instance, if we want to customize the index.html
these are the steps:
-
Step 1
: create thetemplates
DIRECTORY inside your app -
Step 2
: configure the project to use this new template directory- Edit
settings.py
TEMPLATES section
- Edit
-
Step 3
: copy theindex.html
from the original location (inside your ENV) and save it to theYOUR_APP/templates
DIR- Source PATH:
<YOUR_ENV>/LIB/theme_pixel/templates/pages/index.html
- Destination PATH:
YOUR_APP/templates/pages/index.html
- Source PATH:
- Edit the
index.html
(Destination PATH)
At this point, the default version of the index.html
shipped in the library is ignored by Django.
In a similar way, all other files and components can be customized easily.
PRO Version
Seed project powered by Django Framework on top of Pixel PRO design. Pixel
is a premium Bootstrap 5 UI Kit featuring over 200 fully coded UI elements and example pages that will help you prototype and build a website for your next project.
Django Theme Pixel - Modern Theme provided by AppSeed