Skip to content

Commit

Permalink
v1.0.12 - Update RM links
Browse files Browse the repository at this point in the history
  • Loading branch information
@app-generator
app-generator committed Nov 13, 2024
1 parent 59aa9ff commit c0d7401
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 202 deletions.
8 changes: 8 additions & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
# CHANGELOG

## [1.0.12] 2024-11-13
### Changes

- Update RM Links
- [Django Admin Material](https://app-generator.dev/docs/products/django-libs/theme-material-dashboard.html) - **Documentation** & Support Links
- [Django Material Dashboard](https://app-generator.dev/product/material-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.11] 2024-09-16
### Changes

Expand Down
211 changes: 10 additions & 201 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
# [Django Admin Material](https://appseed.us/product/material-dashboard/django/)
# [Django Material Dashboard](https://app-generator.dev/docs/products/django-libs/theme-material-dashboard.html)

Modern **[Django Dashboard](https://appseed.us/admin-dashboards/django/)** that covers `Admin Section`, all authentication pages (registration included) crafted on top of **Material Dashboard**, an open-source `Bootstrap 5` design from `Creative-Tim`.
Modern template for **[Django Admin](https://app-generator.dev/docs/products/django-libs/theme-material-dashboard.html)**, Auth Pages (registration included) crafted on top of **Material Dashboard**, an open-source **Bootstrap** design.

> Actively supported by [AppSeed](https://appseed.us/) via `Email` and `Discord`.
- [Django Admin Material](https://app-generator.dev/docs/products/django-libs/theme-material-dashboard.html) - **Documentation** & Support Links
- [Django Material Dashboard](https://app-generator.dev/product/material-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>
<br />

**Links & Resources**
## **Features**

- [Django Admin Material](https://appseed.us/product/material-dashboard/django/) - `Product page`
- `Features`: Fully-configured, `CI/CD` via Render
- UI Kit: [Material Dashboard BS5](https://www.creative-tim.com/product/material-dashboard?AFFILIATE=128200) `v3.0.5` by Creative-Tim
- Design: **[Material Dashboard](https://app-generator.dev/docs/templates/bootstrap/material-dashboard.html)** (Bootstrap)
- **Sections Covered**:
- `Admin Section`, reserved for `superusers`
- `All pages` managed by `Django.contrib.AUTH`
Expand All @@ -19,200 +19,9 @@ Modern **[Django Dashboard](https://appseed.us/admin-dashboards/django/)** that

<br />

![Material Dashboard - Full-Stack Starter generated by AppSeed.](https://user-images.githubusercontent.com/51070104/169301658-6cf27993-c451-4cd4-9ffa-2968b8981167.png)

<br />

## Why `Django Admin Material`

- 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-material-dashboard
// OR
$ pip install git+https://github.com/app-generator/django-admin-material-dashboard.git
```

<br />

> Add `admin_material` 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_material.apps.AdminMaterialDashboardConfig',
'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_material` urls in your Django Project `urls.py` file
```python
from django.urls import path, include

urlpatterns = [
...
path('', include('admin_material.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, `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
# This exists in ENV: LIB/admin_material
< UI_LIBRARY_ROOT >
|
|-- 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-auth.html # Masterpage for Auth Pages
| |
| |-- pages/
| |-- index.html # Dashboard Page
| |-- profile.html # Profile 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_material/templates/includes/footer.html`
- Destination PATH: `YOUR_APP/templates/includes/footer.html`
- Edit the `footer.html` (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 />

## CSS Styling

The UI can be customized via the SCSS file. This setup was tested using:

- `Node` v16.15.0
- `Yarn` 1.22.18
- `Gulp` CLI version: `2.3.0`, Local version: `4.0.2`

```bash
$ cd admin_material/static
$ yarn # Install Modules
$ vi scss/material-dashboard/_variables.scss # Edit primary, secondary colors
$ gulp # Regenerate CSS files
```

> NOTE, once the CSS files are successfully regenerated, force a hard refresh in the browser (Shift + F5 in Chrome).
The relevant lines in `_variables.scss` are highlighted below:

```SCSS
// _variables.scss, LINES 56 -> 63
$primary: #e91e63 !default; // EDIT & Recompile SCSS
$secondary: #7b809a !default; // EDIT & Recompile SCSS
$info: #1A73E8 !default; // EDIT & Recompile SCSS
$success: #4CAF50 !default; // EDIT & Recompile SCSS
$warning: #fb8c00 !default; // EDIT & Recompile SCSS
$danger: #F44335 !default; // EDIT & Recompile SCSS
$light: $gray-200 !default; // EDIT & Recompile SCSS
$dark: $h-color !default; // EDIT & Recompile SCSS
```

<br />

## [PRO Version](https://appseed.us/product/material-dashboard2-pro/django/)

This design is a pixel-perfect [Bootstrap 5](https://www.admin-dashboards.com/bootstrap-5-templates/) Dashboard with a fresh, new design inspired by Google's Material Design.
`Material Dashboard 2 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`
- UI Theme: `Material2 PRO`
- can be used in any Django project (new or legacy)
- `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`

<br />

![Material Dashboard 2 Pro](https://user-images.githubusercontent.com/51070104/211141418-6b7886eb-6fb3-433e-91c9-2895c086099a.png)
![Django Material Dashboard - Modern template for Django Admin Section crafted on top of a modern Bootstrap Design.](https://user-images.githubusercontent.com/51070104/169301658-6cf27993-c451-4cd4-9ffa-2968b8981167.png)

<br />

---
**[Django Admin Material](https://appseed.us/product/material-dashboard/django/)** - Modern Admin Interface provided by **[AppSeed](https://appseed.us/)**
**[Django Material Dashboard](https://app-generator.dev/docs/products/django-libs/theme-material-dashboard.html)** - Modern Django Admin Interface provided by **[App-Generator](https://app-generator.dev)**
2 changes: 1 addition & 1 deletion setup.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

setup(
name='django-admin-material-dashboard',
version='1.0.11',
version='1.0.12',
zip_safe=False,
packages=find_packages(),
include_package_data=True,
Expand Down

0 comments on commit c0d7401

Please sign in to comment.