Skip to content

Commit 627d992

Browse files
committed
v1.0.5 - Django 5 Fix & Update Links
1 parent 9463aca commit 627d992

File tree

4 files changed

+23
-172
lines changed

4 files changed

+23
-172
lines changed

CHANGELOG.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
11
# CHANGELOG
22

3+
## [1.0.5] 2024-11-16
4+
### Changes
5+
6+
- Remove `length_is` filter
7+
- Deprecated in Django 5.1
8+
- Update RM Links:
9+
- [Django StarAdmin](https://app-generator.dev/docs/products/django-libs/theme-star-admin.html) - **Documentation** & Support Links
10+
- [Getting Started with Django](https://app-generator.dev/docs/technologies/django/index.html) - Learn how to code **Django** Projects
11+
312
## [1.0.4] 2023-03-04
413
### Changes
514

README.md

Lines changed: 9 additions & 167 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,15 @@
1-
# [Django Admin Star](https://appseed.us/product/star-admin/django/)
1+
# [Django StarAdmin](https://app-generator.dev/docs/products/django-libs/theme-star-admin.html)
22

3-
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).
3+
Modern template for **[Django Admin](https://app-generator.dev/docs/products/django-libs/theme-star-admin.html)**, Auth Pages (registration included) crafted on top of **StarAdmin**, an open-source **Bootstrap** design.
44

5-
> Actively supported by [AppSeed](https://appseed.us/) via `Email` and `Discord`.
5+
- [Django StarAdmin](https://app-generator.dev/docs/products/django-libs/theme-star-admin.html) - **Documentation** & Support Links
6+
- [Getting Started with Django](https://app-generator.dev/docs/technologies/django/index.html) - Learn how to code **Django** Projects
67

7-
<br>
8+
<br />
89

9-
**Links & Resources**
10+
## **Features**
1011

11-
- [Django Admin Star](https://appseed.us/product/star-admin/django/) - `Product page`
12-
- `Features`: Fully-configured, `CI/CD` via Render
13-
- UI Kit: [Star Admin BS5](https://www.bootstrapdash.com/product/star-admin-free?ref=23) by `BootstrapDash`
12+
- Design: **[StarAdmin](https://app-generator.dev/docs/templates/bootstrap/staradmin.html)** (Bootstrap)
1413
- **Sections Covered**:
1514
- `Admin Section`, reserved for `superusers`
1615
- `All pages` managed by `Django.contrib.AUTH`
@@ -19,166 +18,9 @@ Modern template for **Django** that covers `Admin Section`, all authentication p
1918

2019
<br />
2120

22-
![Star Admin - Full-Stack Starter generated by AppSeed.](https://user-images.githubusercontent.com/51070104/168732392-51748c85-f2c2-45ad-978c-2b64e52292e2.png)
23-
24-
<br />
25-
26-
## Why `Django Admin Star`
27-
28-
- Modern [Bootstrap 5](https://www.admin-dashboards.com/bootstrap-5-templates/) Design
29-
- `Responsive Interface`
30-
- `Minimal Template` overriding
31-
- `Easy integration`
32-
33-
**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.
34-
35-
<br />
36-
37-
## How to use it
38-
39-
<br />
40-
41-
> **Install the package** via `PIP`
42-
43-
```bash
44-
$ pip install django-admin-star
45-
// OR
46-
$ pip install git+https://github.com/app-generator/django-admin-star.git
47-
```
48-
49-
<br />
50-
51-
> Add `admin_star` application to the `INSTALLED_APPS` setting of your Django project `settings.py` file (note it should be before `django.contrib.admin`):
52-
53-
```python
54-
INSTALLED_APPS = (
55-
...
56-
'admin_star.apps.AdminStarConfig',
57-
'django.contrib.admin',
58-
)
59-
```
60-
61-
<br />
62-
63-
> Add `LOGIN_REDIRECT_URL` and `EMAIL_BACKEND` of your Django project `settings.py` file:
64-
65-
```python
66-
LOGIN_REDIRECT_URL = '/'
67-
# EMAIL_BACKEND = 'django.core.mail.backends.smtp.EmailBackend'
68-
EMAIL_BACKEND = 'django.core.mail.backends.console.EmailBackend'
69-
```
70-
71-
<br />
72-
73-
> Add `admin_star` urls in your Django Project `urls.py` file
74-
75-
```python
76-
from django.urls import path, include
77-
78-
urlpatterns = [
79-
...
80-
path('', include('admin_star.urls')),
81-
]
82-
```
83-
84-
<br />
85-
86-
> **Collect static** if you are in `production environment`:
87-
88-
```bash
89-
$ python manage.py collectstatic
90-
```
91-
92-
<br />
93-
94-
> **Start the app**
95-
96-
```bash
97-
$ # Set up the database
98-
$ python manage.py makemigrations
99-
$ python manage.py migrate
100-
$
101-
$ # Create the superuser
102-
$ python manage.py createsuperuser
103-
$
104-
$ # Start the application (development mode)
105-
$ python manage.py runserver # default port 8000
106-
```
107-
108-
Access the `admin` section in the browser: `http://127.0.0.1:8000/`
109-
110-
<br />
111-
112-
## How to Customize
113-
114-
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.
115-
The theme used to style this starter provides the following files:
116-
117-
```bash
118-
# This exists in ENV: LIB/admin_star
119-
< UI_LIBRARY_ROOT >
120-
|
121-
|-- templates/ # Root Templates Folder
122-
| |
123-
| |-- accounts/
124-
| | |-- login.html # Sign IN Page
125-
| | |-- register.html # Sign UP Page
126-
| |
127-
| |-- includes/
128-
| | |-- footer.html # Footer component
129-
| | |-- sidebar.html # Sidebar component
130-
| | |-- navigation.html # Navigation Bar
131-
| | |-- scripts.html # Scripts Component
132-
| |
133-
| |-- layouts/
134-
| | |-- base.html # Masterpage
135-
| | |-- base-auth.html # Masterpage for Auth Pages
136-
| |
137-
| |-- pages/
138-
| |-- index.html # Dashboard Page
139-
| |-- *.html # All other pages
140-
|
141-
|-- ************************************************************************
142-
```
143-
144-
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.
145-
146-
For instance, if we want to customize the `footer.html` these are the steps:
147-
148-
- `Step 1`: create the `templates` DIRECTORY inside your app
149-
- `Step 2`: configure the project to use this new template directory
150-
- Edit `settings.py` TEMPLATES section
151-
- `Step 3`: copy the `footer.html` from the original location (inside your ENV) and save it to the `YOUR_APP/templates` DIR
152-
- Source PATH: `<YOUR_ENV>/LIB/admin_star/templates/includes/footer.html`
153-
- Destination PATH: `YOUR_APP/templates/includes/footer.html`
154-
- Edit the `footer.html` (Destination PATH)
155-
156-
At this point, the default version of the `footer.html` shipped in the library is ignored by Django.
157-
158-
In a similar way, all other files and components can be customized easily.
159-
160-
<br />
161-
162-
## [PRO Version](https://appseed.us/product/argon-dashboard2-pro/django/)
163-
164-
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.
165-
166-
> Features:
167-
168-
- `Up-to-date Dependencies`
169-
- `Design`: [Django Theme Argon2](https://github.com/app-generator/django-argon-dashboard2-pro) - `PRO Version`
170-
- `Sections` covered by the design:
171-
- **Admin section** (reserved for superusers)
172-
- **Authentication**: `Django.contrib.AUTH`, Registration
173-
- **All Pages** available in for ordinary users
174-
- `Docker`, `Deployment`:
175-
- `CI/CD` flow via `Render`
176-
177-
<br />
178-
179-
![Argon Dashboard 2 PRO - Automotive (Premium Bootstrap 5 Design).](https://user-images.githubusercontent.com/51070104/211158013-fea76b79-bb54-4066-a617-5ec3b4b6ec42.jpg)
21+
![Django StarAdmin - Modern template for Django Admin Section crafted on top of a modern Bootstrap, Open-Source Design.](https://user-images.githubusercontent.com/51070104/168732392-51748c85-f2c2-45ad-978c-2b64e52292e2.png)
18022

18123
<br />
18224

18325
---
184-
**[Django Admin Star](https://appseed.us/product/star-admin/django/)** - Modern Admin Interface provided by **[AppSeed](https://appseed.us/)**
26+
**[Django StarAdmin](https://app-generator.dev/docs/products/django-libs/theme-star-admin.html)** - Modern Django Admin Interface provided by **[App-Generator](https://app-generator.dev)**

admin_star/templates/admin/includes/fieldset.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,12 @@
77
{% for line in fieldset %}
88
<div class="row">
99
<div class="{% if line.fields.0 in 'last_login, date_joined' %}col-md-6{% else %}col-md-12{% endif %}">
10-
<div class="mb-4 {% if line.fields|length_is:'1' and line.errors %} errors{% endif %}{% if not line.has_visible_field %} hidden{% endif %}{% for field in line %}{% if field.field.name %} field-{{ field.field.name }}{% endif %}{% endfor %}">
11-
{% if line.fields|length_is:'1' %}{{ line.errors }}{% endif %}
10+
<div class="mb-4 {% if line.fields|length == 1 and line.errors %} errors{% endif %}{% if not line.has_visible_field %} hidden{% endif %}{% for field in line %}{% if field.field.name %} field-{{ field.field.name }}{% endif %}{% endfor %}">
11+
{% if line.fields|length == 1 %}{{ line.errors }}{% endif %}
1212
{% for field in line %}
13-
{# <div{% if not line.fields|length_is:'1' %} class="fieldBox{% if field.field.name %} field-{{ field.field.name }}{% endif %}{% if not field.is_readonly and field.errors %} errors{% endif %}{% if field.field.is_hidden %} hidden{% endif %}"{% elif field.is_checkbox %} class="checkbox-row"{% endif %}>#}
13+
{# <div{% if not line.fields|length == 1 %} class="fieldBox{% if field.field.name %} field-{{ field.field.name }}{% endif %}{% if not field.is_readonly and field.errors %} errors{% endif %}{% if field.field.is_hidden %} hidden{% endif %}"{% elif field.is_checkbox %} class="checkbox-row"{% endif %}>#}
1414

15-
{% if not line.fields|length_is:'1' and not field.is_readonly %}
15+
{% if not line.fields|length == 1 and not field.is_readonly %}
1616
{{ field.errors }}
1717
{% endif %}
1818

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
description='Modern template for Django admin interface - Star Admin Design (BS5)',
1616
long_description=README,
1717
long_description_content_type="text/markdown",
18-
url='https://appseed.us/product/star-admin/django/',
18+
url='https://app-generator.dev/docs/products/django-libs/theme-star-admin.html',
1919
author='AppSeed.us',
2020
author_email='[email protected]',
2121
license='MIT License',

0 commit comments

Comments
 (0)