diff --git a/CHANGELOG.md b/CHANGELOG.md index 401479c..456713c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -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 diff --git a/README.md b/README.md index 00904a5..f21c9f5 100644 --- a/README.md +++ b/README.md @@ -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
-## 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 - -
- -![Django Corporate Dashboard](https://user-images.githubusercontent.com/51070104/229719846-cfe96c5c-89c2-4ea0-89a9-7be69ebbb228.png) - -
- -## Why `Django Admin Corporate` - -- 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-corporate -// OR -$ pip install git+/~https://github.com/app-generator/django-admin-corporate.git -``` - -
- -> 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', - ) -``` - -
- -> 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_corporate` urls in your Django Project `urls.py` file - -```python - from django.urls import path, include - - urlpatterns = [ - ... - path('', include('admin_corporate.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 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: `/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. - -
- -## 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)
--- -**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)** diff --git a/admin_corporate/templates/admin/includes/fieldset.html b/admin_corporate/templates/admin/includes/fieldset.html index afb813a..56a8d1b 100644 --- a/admin_corporate/templates/admin/includes/fieldset.html +++ b/admin_corporate/templates/admin/includes/fieldset.html @@ -7,12 +7,12 @@ {% for line in fieldset %}
-
- {% if line.fields|length_is:'1' %}{{ line.errors }}{% endif %} +
+ {% if line.fields|length == 1 %}{{ line.errors }}{% endif %} {% for field in line %} - {# #} + {# #} - {% 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 %} diff --git a/setup.py b/setup.py index 0c66492..7cdcabf 100644 --- a/setup.py +++ b/setup.py @@ -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',