Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/app-generator/django-admin-volt
Django Admin Volt - Free template for Django Admin Interface | AppSeed
https://github.com/app-generator/django-admin-volt
admin-dashboard django django-admin-theme django-bootstrap django-library django-template django-theme open-source
Last synced: 4 days ago
JSON representation
Django Admin Volt - Free template for Django Admin Interface | AppSeed
- Host: GitHub
- URL: https://github.com/app-generator/django-admin-volt
- Owner: app-generator
- License: mit
- Created: 2021-09-26T15:11:50.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-09-16T11:29:22.000Z (about 2 months ago)
- Last Synced: 2024-10-11T04:43:30.570Z (24 days ago)
- Topics: admin-dashboard, django, django-admin-theme, django-bootstrap, django-library, django-template, django-theme, open-source
- Language: CSS
- Homepage: https://pypi.org/project/django-admin-volt/
- Size: 8.04 MB
- Stars: 141
- Watchers: 9
- Forks: 33
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-django-admin - django-admin-volt - Modern Bootstrap5 Design (Packages to install at your project / Alternative Themes)
- awesome-django - django-admin-vol - Modern Bootstrap5 Design (Admin interface)
README
# [Django Admin Volt](https://appseed.us/product/volt-dashboard/django/)
Modern template for **Django** that covers `Admin Section`, all authentication pages (registration included) crafted on top of **[Volt Dashboard](https://appseed.us/product/volt-dashboard/django/)**, an open-source `Bootstrap 5` design from `Themesberg`.
> Actively supported by [AppSeed](https://appseed.us/) via `Email` and `Discord`.
**Links & Resources**
- [Django Admin Volt](https://appseed.us/product/volt-dashboard/django/) - `Product` that uses the library
- `Features`: Fully-configured, `CI/CD` via Render
- UI Kit: Volt Dashboard BS5 `v1.4.1` by Themesberg
- **Sections Covered**:
- `Admin Section`, reserved for `superusers`
- `All pages` managed by `Django.contrib.AUTH`
- `Registration` page
- `Misc pages`: colors, icons, typography, blank-page
## Why `Django Admin Volt`
- Modern [Bootstrap 5](https://www.admin-dashboards.com/bootstrap-5-templates/) Design
- `Responsive Interface`
- `Minimal Template` overriding
- `Easy integration`
## How to use it
> **Install the package** via `PIP`
```bash
$ pip install django-admin-volt
// OR
$ pip install git+https://github.com/app-generator/django-admin-volt.git
```
> Add `admin_volt` application to the `INSTALLED_APPS` setting of your Django project `settings.py` file (note it should be before `django.contrib.admin`):
```python
INSTALLED_APPS = (
...
'admin_volt.apps.AdminVoltConfig',
'django.contrib.admin',
)
```
> Add `LOGIN_REDIRECT_URL` and `EMAIL_BACKEND` of your Django project `settings.py` file:
```python
LOGIN_REDIRECT_URL = '/'
# EMAIL_BACKEND = 'django.core.mail.backends.smtp.EmailBackend'
EMAIL_BACKEND = 'django.core.mail.backends.console.EmailBackend'
```
> Add `admin_volt` urls in your Django Project `urls.py` file
```python
from django.urls import path, include
urlpatterns = [
...
path('', include('admin_volt.urls')),
]
```
> **Collect static** if you are in `production environment`:
```bash
$ python manage.py collectstatic
```
> **Start the app**
```bash
$ # 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
```
Access the `admin` section in the browser: `http://127.0.0.1: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:
```bash
# This exists in ENV: LIB/admin_volt
< 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
| | |-- sidebar.html # Sidebar component
| | |-- navigation.html # Navigation Bar
| | |-- scripts.html # Scripts Component
| |
| |-- layouts/
| | |-- base.html # Masterpage
| | |-- base-auth.html # Masterpage for Auth Pages
| |
| |-- pages/
| |-- index.html # Dashboard Page
| |-- settings.html # Profile 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 `footer.html` these are the steps:
- `Step 1`: create the `templates` DIRECTORY inside your app
- `Step 2`: configure the project to use this new template directory
- Edit `settings.py` TEMPLATES section
- `Step 3`: copy the `footer.html` from the original location (inside your ENV) and save it to the `YOUR_APP/templates` DIR
- Source PATH: `/LIB/admin_volt/templates/includes/footer.html`
- Destination PATH: `YOUR_APP/templates/includes/footer.html`
- Edit the `footer.html` (Destination PATH)
At this point, the default version of the `footer.html` shipped in the library is ignored by Django.
In a similar way, all other files and components can be customized easily.
## [PRO Version](https://appseed.us/product/volt-dashboard-pro/django/)
This design is a pixel-perfect [Bootstrap 5](https://www.admin-dashboards.com/bootstrap-5-templates/) Dashboard with a fresh, new design. `Volt Dashboard PRO` is built with over 300 frontend individual elements, like buttons, inputs, navbars, nav tabs, cards, or alerts, giving you the freedom of choosing and combining.
> Features:
- `Up-to-date Dependencies`
- `Design`: [Django Theme Volt](https://github.com/app-generator/django-volt-dashboard-pro) - `PRO Version`
- `Sections` covered by the design:
- **Admin section** (reserved for superusers)
- **Authentication**: `Django.contrib.AUTH`, Registration
- **All Pages** available in for ordinary users
- `Docker`, `Deployment`:
- `CI/CD` flow via `Render`
---
**[Django Admin Volt](https://appseed.us/product/volt-dashboard/django/)** - Modern Admin Interface provided by **[AppSeed](https://appseed.us/)**