Skip to content

Commit

Permalink
v1.0.3 - Fix for Django5 & Links Update
Browse files Browse the repository at this point in the history
  • Loading branch information
@app-generator
app-generator committed Nov 17, 2024
1 parent 145bcd6 commit ad08d59
Show file tree
Hide file tree
Showing 4 changed files with 26 additions and 175 deletions.
10 changes: 10 additions & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,15 @@
# CHANGELOG

## [1.0.3] 2024-09-17
### Changes

- Remove `length_is` filter
- Deprecated in Django 5.1
- Update RM Links
- [Django Corporate](https://app-generator.dev/docs/products/django-libs/theme-corporate.html) - Documentation & Support Links
- [Django Corporate](https://app-generator.dev/product/corporate-dashboard/django/) - The product that uses the library
- [Getting Started with Django](https://app-generator.dev/docs/technologies/django/index.html) - Learn how to code **Django** Projects

## [1.0.2] 2023-05-08
### Changes

Expand Down
179 changes: 10 additions & 169 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,186 +1,27 @@
# Django Admin Corporate
# [Django Corporate](https://app-generator.dev/docs/products/django-libs/theme-corporate.html)

Modern template for **Django Admin Interface** coded on top of **Corporate UI Dashboard**, an open-source `Bootstrap 5` design from [Creative-Tim](https://www.creative-tim.com/?AFFILIATE=128200).
Modern template for **Django Admin**, Auth Pages (registration included) crafted on top of **Corporate**, an open-source **Bootstrap** design.

> Actively supported by [AppSeed](https://appseed.us/) via `Email` and `Discord`.
- [Django Corporate](https://app-generator.dev/docs/products/django-libs/theme-corporate.html) - Documentation & Support Links
- [Django Corporate](https://app-generator.dev/product/corporate-dashboard/django/) - The product that uses the library
- [Getting Started with Django](https://app-generator.dev/docs/technologies/django/index.html) - Learn how to code **Django** Projects

<br />

## Features:
## **Features**

- [Django Corporate Dashboard](/~https://github.com/app-generator/django-corporate-dashboard) - `Product` that uses the library
- `Features`: Fully-configured, `CI/CD` via Render
- **UI Kit**: [Corporate Dashboard BS5](https://www.creative-tim.com/product/corporate-ui-dashboard?AFFILIATE=128200) by `Creative-Tim`
- Design: **[Corporate](https://app-generator.dev/docs/templates/bootstrap/corporate.html)** (Bootstrap)
- **Sections Covered**:
- `Admin Section`, reserved for `superusers`
- `All pages` managed by `Django.contrib.AUTH`
- `Registration` page
- `Misc pages`: colors, icons, typography, blank-page

<br />

![Django Corporate Dashboard](https://user-images.githubusercontent.com/51070104/229719846-cfe96c5c-89c2-4ea0-89a9-7be69ebbb228.png)

<br>

## Why `Django Admin Corporate`

- Modern [Bootstrap 5](https://www.admin-dashboards.com/bootstrap-5-templates/) Design
- `Responsive Interface`
- `Minimal Template` overriding
- `Easy integration`

<br />

## How to use it

<br />

> **Install the package** via `PIP`
```bash
$ pip install django-admin-corporate
// OR
$ pip install git+/~https://github.com/app-generator/django-admin-corporate.git
```

<br />

> Add `admin_corporate` 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_corporate.apps.AdminCorporateConfig',
'django.contrib.admin',
)
```

<br />

> 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'
```

<br />

> Add `admin_corporate` urls in your Django Project `urls.py` file
```python
from django.urls import path, include

urlpatterns = [
...
path('', include('admin_corporate.urls')),
]
```


<br />

> **Collect static** if you are in `production environment`:
```bash
$ python manage.py collectstatic
```

<br />

> **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/`

<br />

## How to Customize

When a template file is loaded in the controller, `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
< LIBRARY_ROOT > # This exists in ENV: LIB/admin_corporate
|
|-- 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-fullscreen.html # Masterpage for Auth Pages
| |
| |-- pages/
| |-- index.html # Dashboard page
| |-- profile.html # Settings 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: `<YOUR_ENV>/LIB/admin_corporate/includes/footer.html`
- Destination PATH: `YOUR_APP/templates/includes/footer.html`
- Edit the footer (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.

<br />

## Recompile SCSS

The SCSS/CSS files used to style the Ui are saved in the `static` directory.
In order to update the Ui colors (primary, secondary) this procedure needs to be followed.

```bash
$ yarn # Install modules
$ # Edit variables
$ vi admin_corporate/static/scss/corporate-ui-dashboard/_variables.scss
$ gulp # SCSS to CSS translation
```

The `_variables.scss` content defines the `primary` and `secondary` colors:

```scss
$primary: #774dd3 !default; // EDIT for customization
$secondary: #64748b !default; // EDIT for customization
$info: #55a6f8 !default; // EDIT for customization
$success: #67c23a !default; // EDIT for customization
$warning: #f19937 !default; // EDIT for customization
$danger: #ea4e3d !default; // EDIT for customization
```
![Django Corporate - Modern template for Django Admin Section crafted on top of a modern Bootstrap, Open-Source Design.](/~https://github.com/user-attachments/assets/55f27009-2e46-433c-b2bc-4c0db1cd6c17)

<br />

---
**Django Admin Corporate** - Modern Admin Interface provided by **[AppSeed](https://appseed.us/)**
**[Django Corporate](https://app-generator.dev/docs/products/django-libs/theme-corporate.html)** - Modern Django Admin Interface provided by **[App-Generator](https://app-generator.dev)**
8 changes: 4 additions & 4 deletions admin_corporate/templates/admin/includes/fieldset.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@
{% for line in fieldset %}
<div class="row">
<div class="{% if line.fields.0 in 'last_login, date_joined' %}col-md-6{% else %}col-md-12{% endif %}">
<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 %}">
{% if line.fields|length_is:'1' %}{{ line.errors }}{% endif %}
<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 %}">
{% if line.fields|length == 1 %}{{ line.errors }}{% endif %}
{% for field in line %}
{# <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 %}>#}
{# <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 %}>#}

{% if not line.fields|length_is:'1' and not field.is_readonly %}
{% if not line.fields|length == 1 and not field.is_readonly %}
{{ field.errors }}
{% endif %}

Expand Down
4 changes: 2 additions & 2 deletions setup.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,14 @@

setup(
name='django-admin-corporate',
version='1.0.2',
version='1.0.3',
zip_safe=False,
packages=find_packages(),
include_package_data=True,
description='Modern template for Django admin interface',
long_description=README,
long_description_content_type="text/markdown",
url='https://appseed.us/product/corporate-ui-dashboard/django/',
url='https://app-generator.dev/docs/products/django-libs/theme-corporate.html',
author='AppSeed.us',
author_email='support@appseed.us',
license='MIT License',
Expand Down

0 comments on commit ad08d59

Please sign in to comment.