https://github.com/app-generator/django-admin-star
Django Admin Star - Free template for Django Admin UI | AppSeed
https://github.com/app-generator/django-admin-star
appseed django-template django-theme star-admin
Last synced: 3 months ago
JSON representation
Django Admin Star - Free template for Django Admin UI | AppSeed
- Host: GitHub
- URL: https://github.com/app-generator/django-admin-star
- Owner: app-generator
- License: mit
- Created: 2022-12-11T09:57:36.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-11-16T07:11:07.000Z (7 months ago)
- Last Synced: 2025-03-11T05:55:15.727Z (4 months ago)
- Topics: appseed, django-template, django-theme, star-admin
- Language: CSS
- Homepage: https://app-generator.dev/docs/products/django-libs/theme-star-admin.html
- Size: 29.2 MB
- Stars: 7
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# [Django Admin Star](https://appseed.us/product/star-admin/django/)
Modern template for **Django** that covers `Admin Section`, all authentication pages (registration included) crafted on top of **[Star Admin](https://appseed.us/product/star-admin/django/)**, an open-source `Bootstrap 5` design from [BootstrapDash](https://www.bootstrapdash.com/product/star-admin-free?ref=23).
> Actively supported by [AppSeed](https://appseed.us/) via `Email` and `Discord`.
**Links & Resources**
- [Django Admin Star](https://appseed.us/product/star-admin/django/) - `Product page`
- `Features`: Fully-configured, `CI/CD` via Render
- UI Kit: [Star Admin BS5](https://www.bootstrapdash.com/product/star-admin-free?ref=23) by `BootstrapDash`
- **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 Star`
- Modern [Bootstrap 5](https://www.admin-dashboards.com/bootstrap-5-templates/) Design
- `Responsive Interface`
- `Minimal Template` overriding
- `Easy integration`
**Star Admin** is a free admin dashboard template built with **[Bootstrap 5](https://www.admin-dashboards.com/bootstrap-5-templates/)**. We took the original `Star Admin` and gave it a design overhaul along with newly written code to create our best template yet. This is a modern-looking dashboard with a clean and elegant design.
## How to use it
> **Install the package** via `PIP`
```bash
$ pip install django-admin-star
// OR
$ pip install git+https://github.com/app-generator/django-admin-star.git
```
> Add `admin_star` 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_star.apps.AdminStarConfig',
'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_star` urls in your Django Project `urls.py` file
```python
from django.urls import path, include
urlpatterns = [
...
path('', include('admin_star.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_star
< UI_LIBRARY_ROOT >
|
|-- templates/ # Root Templates Folder
| |
| |-- accounts/
| | |-- login.html # Sign IN Page
| | |-- register.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
| |-- *.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_star/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/argon-dashboard2-pro/django/)
This design is a pixel-perfect [Bootstrap 5](https://www.admin-dashboards.com/bootstrap-5-templates/) Dashboard with a fresh, new design. Argon is a completly new product built on our newest re-built from scratch framework structure that is meant to make our products more intuitive, more adaptive and, needless to say, so much easier to customize.
> Features:
- `Up-to-date Dependencies`
- `Design`: [Django Theme Argon2](https://github.com/app-generator/django-argon-dashboard2-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 Star](https://appseed.us/product/star-admin/django/)** - Modern Admin Interface provided by **[AppSeed](https://appseed.us/)**