Git Product home page Git Product logo

app-generator / django-admin-soft-dashboard Goto Github PK

View Code? Open in Web Editor NEW
38.0 3.0 22.0 25.63 MB

Django Admin Soft - Free template for Django Admin UI | AppSeed

Home Page: https://pypi.org/project/django-admin-soft-dashboard/

License: MIT License

Python 1.80% CSS 35.04% JavaScript 1.74% SCSS 35.47% HTML 25.95%
django-admin-theme django-template django-theme django-soft-design soft-ui-dashboard soft-ui-design soft-ui-desing-system django-soft-sample django-theme-soft-design soft-design-django

django-admin-soft-dashboard's Introduction

Modern Django Dashboard Admin Interface coded on top of Soft UI Dashboard, an open-source Bootstrap 5 design from Creative-Tim.

Actively supported by AppSeed via Email and Discord.


Features:

  • Django Soft Dashboard - Product that uses the library
    • Features: Fully-configured, CI/CD via Render
  • UI Kit: Soft Dashboard BS5 by Creative-Tim
  • Sections Covered:
    • Admin Section, reserved for superusers
    • All pages managed by Django.contrib.AUTH
    • Registration page
    • Misc pages: colors, icons, typography, blank-page

Django Admin Soft - Template project for Django provided by AppSeed.


Why Django Admin Soft

  • Modern Bootstrap 5 Design
  • Responsive Interface
  • Minimal Template overriding
  • Easy integration

How to use it


Install the package via PIP

$ pip install django-admin-soft-dashboard
// OR
$ pip install git+https://github.com/app-generator/django-admin-soft-dashboard.git

Add admin_soft application to the INSTALLED_APPS setting of your Django project settings.py file (note it should be before django.contrib.admin):

    INSTALLED_APPS = (
        ...
        'admin_soft.apps.AdminSoftDashboardConfig',
        'django.contrib.admin',
    )

Add LOGIN_REDIRECT_URL and EMAIL_BACKEND of your Django project settings.py file:

    LOGIN_REDIRECT_URL = '/'
    # EMAIL_BACKEND = 'django.core.mail.backends.smtp.EmailBackend'
    EMAIL_BACKEND = 'django.core.mail.backends.console.EmailBackend'

Add admin_soft urls in your Django Project urls.py file

    from django.urls import path, include

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

Collect static if you are in production environment:

$ python manage.py collectstatic

Start the app

$ # 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:

< LIBRARY_ROOT >                      # This exists in ENV: LIB/admin_soft
   |
   |-- 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_soft/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.

$ yarn                                                        # install modules
$ vi admin_soft/static/scss/soft-ui-dashboard/_variables.scss # edit variables 
$ gulp                                                        # SCSS to CSS translation

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

$primary:       #cb0c9f !default;   // EDIT for customization 
$secondary:     #8392AB !default;   // EDIT for customization 
$info:          #17c1e8 !default;   // EDIT for customization 
$success:       #82d616 !default;   // EDIT for customization 
$warning:       #fbcf33 !default;   // EDIT for customization 
$danger:        #ea0606 !default;   // EDIT for customization 

This design is a pixel-perfect Bootstrap 5 Dashboard with a fresh, new design concept. Soft UI 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 Soft 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

Soft UI Dashboard Pro



Django Admin Soft - Modern Admin Interface provided by AppSeed

django-admin-soft-dashboard's People

Contributors

app-generator avatar mominur-helios avatar mysecondlanguage avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

django-admin-soft-dashboard's Issues

filter_horizontal not supported

I added the UI soft dashboard theme to my project which has M2M relation and in admin I added to the ModelAdmin class the filter_horizontal which will help to select the items as the following photo. But this is not exist in the theme.
72eOv

ENH - Template Refactoring

Hello @MySecondLanguage

The template works but the files & components require a new structure.
The design should be usable in two contexts:

  • super users
  • common users

This dual context should be reflected in the structure of the files and of course taking into account the files as expected by Django.

<ROOT_DIR>
    |-- templates/
         |
         |-- admin/                           # Admin ONLY specific pages & helpers
         |    |-- index.html                  # Admin Index
         |
         |-- includes/                        # HTML chunks and components
         |    |-- navigation.html             # Top menu component
         |    |-- navigation-rtl.html         # Top menu component
         |    |-- sidebar.html                # Sidebar component
         |    |-- footer.html                 # App Footer
         |    |-- scripts.html                # Scripts common to all pages
         |
         |-- layouts/                         # Master pages
         |    |-- base.html                   # Used by common pages
         |    |-- base-fullscreen.html        # Used by Authentication pages
         |    |-- base-rtl.html               # Used in RTL pages
         |
         |-- accounts/                        # AUTH pages (common users)
         |    |-- login.html                  # Login page
         |    |-- register.html               # Register page
         |
         |-- pages/                           # UI Kit Pages
              |-- index.html                  # Users Index
              |-- 404-page.html               # 404 page
              |-- *.html                      # All other pages

Here is short information regarding all directors:

  • layouts: contains master pages used in all contexts
  • includes: shared components like footer, navigation + variants like navigation-rtl
  • accounts: auth pages used by common users to authenticate
    • use case: the product can be used outside the admin zone
  • pages: all other pages provided by the kit

Index pages

  • SuperUsers: the sidebar will contain only admin-specific items and a link to the users' dashboard
    • Location: templates/admin/index.html
  • Common Users
    • Location: templates/pages/index.html

Note: all unused components, pages, and temporary code should be removed in order to avoid confusion and provide quality to the users.

django.contrib.auth - Missing pages

Hello @MySecondLanguage

All pages required by django.contrib.auth are missing:

The following paths should work + registration page (outside of admin section)

accounts/register/ [name='register'] 
accounts/login/ [name='login']
accounts/logout/ [name='logout']
accounts/password_change/ [name='password_change']
accounts/password_change/done/ [name='password_change_done']
accounts/password_reset/ [name='password_reset']
accounts/password_reset/done/ [name='password_reset_done']
accounts/reset/<uidb64>/<token>/ [name='password_reset_confirm']
accounts/reset/done/ [name='password_reset_complete']

Please take a look.

ty!

Checkbox and some model elements

Checkbox is not at his place as you can see in the picture, also its supposed to be selecting everything but it is not. Also you could find that ok button is not aligned.

Thank you for everything, the rest is going great!
Screenshot 2023-03-03 at 13 21 47

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.