Git Product home page Git Product logo

app-generator / django-admin-black Goto Github PK

View Code? Open in Web Editor NEW
64.0 5.0 23.0 4.24 MB

Django Admin Black - Free template for Django Admin Interface | AppSeed

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

License: MIT License

Python 2.58% CSS 38.61% JavaScript 2.95% SCSS 34.23% HTML 21.63%
django-template django-admin-theme django-theme black-design dark-design dark-theme django-admin django-admin-themes django-dark-theme

django-admin-black's Introduction

Modern template for Django that covers Admin Section, all authentication pages (registration included) crafted on top of Black Dashboard, an open-source Bootstrap 5 design from Creative-Tim.

Actively supported by AppSeed via Email and Discord.


Links & Resources

  • Django Black Dashboard - Product that uses the library
    • Features: Fully-configured, CI/CD via Render
  • UI Kit: Black Dashboard free version 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 Black - Template project for Django provided by AppSeed.


Why Django Black Design

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

How to use it


Install the package via PIP

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

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

    INSTALLED_APPS = (
        ...
        'admin_black.apps.AdminBlackConfig',
        'django.contrib.admin',
    )

Add admin_black urls in your Django Project urls.py file.

    from django.urls import path, include

    urlpatterns = [
        ...
        path('', include('admin_black.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:

# This exists in ENV: LIB/admin_black
< UI_LIBRARY_ROOT >                      
   |
   |-- templates/                     # Root Templates Folder 
   |    |          
   |    |-- accounts/       
   |    |    |-- auth-signin.html     # Sign IN Page
   |    |    |-- auth-signup.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
   |    |
   |    |-- pages/       
   |         |-- dashboard.html       # Dashboard page
   |         |-- user.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 dashboard.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 dashboard.html from the original location (inside your ENV) and save it to the YOUR_APP/templates DIR
    • Source PATH: <YOUR_ENV>/LIB/admin_black/pages/dashboard.html
    • Destination PATH: YOUR_APP/templates/pages/dashboard.html
  • Edit the footer (Destination PATH)

At this point, the default version of the dashboard.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 admin_black/static/assets directory. In order to update the Ui colors (primary, secondary) this procedure needs to be followed.

$ yarn # install modules
$ # # edit variables 
$ vi static/assets/scss/black-dashboard/custom/_variables.scss 
$ gulp # SCSS to CSS translation

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

$default:       #344675 !default; // EDIT for customization
$primary:       #e14eca !default; // EDIT for customization
$secondary:     #f4f5f7 !default; // EDIT for customization
$success:       #00f2c3 !default; // EDIT for customization
$info:          #1d8cf8 !default; // EDIT for customization
$warning:       #ff8d72 !default; // EDIT for customization
$danger:        #fd5d93 !default; // EDIT for customization
$black:         #222a42 !default; // EDIT for customization

This design is a pixel-perfect Bootstrap Dashboard with a fresh, new design. Black 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 Black - 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 Black PRO - Premium Seed project powered by Flask.



Django Admin Black - Modern Admin Interface provided by AppSeed

django-admin-black's People

Contributors

app-generator avatar imankarimi avatar imran-helios avatar mominur-helios 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  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  avatar  avatar

django-admin-black's Issues

[Django 4.0.1] cannot import name 'smart_text' from 'django.utils.encoding'

This happens when installing in existing project.

Django 4.0.1

django.template.library.InvalidTemplateLibrary: Invalid template library specified. ImportError raised when trying to load 'admin_black.templatetags.admin_black': cannot import name 'smart_text' from 'django.utils.encoding' (/usr/local/lib/python3.9/site-packages/django/utils/encoding.py)

Registration form is incompatible with custom user models

as you can see here
ΒΆ If you reference User directly (for example, by referring to it in a foreign key), your code will not work in projects where the AUTH_USER_MODEL setting has been changed to a different user model.

In your RegistrationForm you do just that, which causes an error Manager isn't available; 'auth.User' has been swapped for 'users.User'

As I see it only happens in one form in forms.py, so fixing this problem and making your users' lives will be very easy.

from django.contrib.auth import get_user_model
# model = User
model = get_user_model()

pagination on Django-tables2

I am using django-tables2 and the numbers showing at the bottom for pagination don't look right. In fact ideally it should be consistent with the pagination shown in the admin sections.

Currently looks like

image

Should look like

image

Check box and select all not working in admin

I am not able to see a check box above the list of items in my admin panel. For example I have a model called People. When using the default Django install I am able to see a check box that allows me to select all items on that page. With the Django admin black enabled I can see that check box. See images below.

Django Black Admin
image

Default Django
image

Note the little check box next to the ID in the second image.

The model User is not registered

Hi, I am using custom user model, when I am trying to setup admin-black it throws exception NotRegistered('The model %s is not registered' % model.name), django.contrib.admin.sites.NotRegistered: The model User is not registered.

check black-dashboard.css for syntax errors

Am seeing a lot of errors reported in Pycharm about black-dashboard.css. Overall 13 problems reported. On lines
2108,4247,4516,4520,4524, 12554, 16831, 16838, 16842, 19793.

examples:

Mismatched property value (none | # | [initial | inherit | unset | revert])

Mismatched property value ([ || || || ]? [/ ]? | caption | icon | menu | message-box | small-caption | status-bar | | | [initial | inherit | unset | revert])

Cannot resolve file 'bg.gif'

Term expected:

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.