Skip to content

Commit c0d7401

Browse files
app-generatorapp-generator
committed
v1.0.12 - Update RM links
1 parent 59aa9ff commit c0d7401

File tree

3 files changed

+19
-202
lines changed

3 files changed

+19
-202
lines changed

Diff for: ‎CHANGELOG.md

+8
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
11
# CHANGELOG
22

3+
## [1.0.12] 2024-11-13
4+
### Changes
5+
6+
- Update RM Links
7+
- [Django Admin Material](https://app-generator.dev/docs/products/django-libs/theme-material-dashboard.html) - **Documentation** & Support Links
8+
- [Django Material Dashboard](https://app-generator.dev/product/material-dashboard/django/) - The product that uses the library
9+
- [Getting Started with Django](https://app-generator.dev/docs/technologies/django/index.html) - Learn how to code **Django** Projects
10+
311
## [1.0.11] 2024-09-16
412
### Changes
513

Diff for: ‎README.md

+10-201
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
1-
# [Django Admin Material](https://appseed.us/product/material-dashboard/django/)
1+
# [Django Material Dashboard](https://app-generator.dev/docs/products/django-libs/theme-material-dashboard.html)
22

3-
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`.
3+
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.
44

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

7-
<br>
9+
<br />
810

9-
**Links & Resources**
11+
## **Features**
1012

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

2020
<br />
2121

22-
![Material Dashboard - Full-Stack Starter generated by AppSeed.](https://user-images.githubusercontent.com/51070104/169301658-6cf27993-c451-4cd4-9ffa-2968b8981167.png)
23-
24-
<br />
25-
26-
## Why `Django Admin Material`
27-
28-
- Modern [Bootstrap 5](https://www.admin-dashboards.com/bootstrap-5-templates/) Design
29-
- `Responsive Interface`
30-
- `Minimal Template` overriding
31-
- `Easy integration`
32-
33-
<br />
34-
35-
## How to use it
36-
37-
<br />
38-
39-
> **Install the package** via `PIP`
40-
41-
```bash
42-
$ pip install django-admin-material-dashboard
43-
// OR
44-
$ pip install git+https://github.com/app-generator/django-admin-material-dashboard.git
45-
```
46-
47-
<br />
48-
49-
> Add `admin_material` application to the `INSTALLED_APPS` setting of your Django project `settings.py` file (note it should be before `django.contrib.admin`):
50-
51-
```python
52-
INSTALLED_APPS = (
53-
...
54-
'admin_material.apps.AdminMaterialDashboardConfig',
55-
'django.contrib.admin',
56-
)
57-
```
58-
59-
<br />
60-
61-
> Add `LOGIN_REDIRECT_URL` and `EMAIL_BACKEND` of your Django project `settings.py` file:
62-
63-
```python
64-
LOGIN_REDIRECT_URL = '/'
65-
# EMAIL_BACKEND = 'django.core.mail.backends.smtp.EmailBackend'
66-
EMAIL_BACKEND = 'django.core.mail.backends.console.EmailBackend'
67-
```
68-
69-
<br />
70-
71-
> Add `admin_material` urls in your Django Project `urls.py` file
72-
73-
```python
74-
from django.urls import path, include
75-
76-
urlpatterns = [
77-
...
78-
path('', include('admin_material.urls')),
79-
]
80-
```
81-
82-
<br />
83-
84-
> **Collect static** if you are in `production environment`:
85-
86-
```bash
87-
$ python manage.py collectstatic
88-
```
89-
90-
<br />
91-
92-
> **Start the app**
93-
94-
```bash
95-
$ # Set up the database
96-
$ python manage.py makemigrations
97-
$ python manage.py migrate
98-
$
99-
$ # Create the superuser
100-
$ python manage.py createsuperuser
101-
$
102-
$ # Start the application (development mode)
103-
$ python manage.py runserver # default port 8000
104-
```
105-
106-
Access the `admin` section in the browser: `http://127.0.0.1:8000/`
107-
108-
<br />
109-
110-
## How to Customize
111-
112-
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.
113-
The theme used to style this starter provides the following files:
114-
115-
```bash
116-
# This exists in ENV: LIB/admin_material
117-
< UI_LIBRARY_ROOT >
118-
|
119-
|-- templates/ # Root Templates Folder
120-
| |
121-
| |-- accounts/
122-
| | |-- login.html # Sign IN Page
123-
| | |-- register.html # Sign UP Page
124-
| |
125-
| |-- includes/
126-
| | |-- footer.html # Footer component
127-
| | |-- sidebar.html # Sidebar component
128-
| | |-- navigation.html # Navigation Bar
129-
| | |-- scripts.html # Scripts Component
130-
| |
131-
| |-- layouts/
132-
| | |-- base.html # Masterpage
133-
| | |-- base-auth.html # Masterpage for Auth Pages
134-
| |
135-
| |-- pages/
136-
| |-- index.html # Dashboard Page
137-
| |-- profile.html # Profile Page
138-
| |-- *.html # All other pages
139-
|
140-
|-- ************************************************************************
141-
```
142-
143-
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.
144-
145-
For instance, if we want to customize the `footer.html` these are the steps:
146-
147-
- `Step 1`: create the `templates` DIRECTORY inside your app
148-
- `Step 2`: configure the project to use this new template directory
149-
- Edit `settings.py` TEMPLATES section
150-
- `Step 3`: copy the `footer.html` from the original location (inside your ENV) and save it to the `YOUR_APP/templates` DIR
151-
- Source PATH: `<YOUR_ENV>/LIB/admin_material/templates/includes/footer.html`
152-
- Destination PATH: `YOUR_APP/templates/includes/footer.html`
153-
- Edit the `footer.html` (Destination PATH)
154-
155-
At this point, the default version of the `footer.html` shipped in the library is ignored by Django.
156-
157-
In a similar way, all other files and components can be customized easily.
158-
159-
<br />
160-
161-
## CSS Styling
162-
163-
The UI can be customized via the SCSS file. This setup was tested using:
164-
165-
- `Node` v16.15.0
166-
- `Yarn` 1.22.18
167-
- `Gulp` CLI version: `2.3.0`, Local version: `4.0.2`
168-
169-
```bash
170-
$ cd admin_material/static
171-
$ yarn # Install Modules
172-
$ vi scss/material-dashboard/_variables.scss # Edit primary, secondary colors
173-
$ gulp # Regenerate CSS files
174-
```
175-
176-
> NOTE, once the CSS files are successfully regenerated, force a hard refresh in the browser (Shift + F5 in Chrome).
177-
178-
The relevant lines in `_variables.scss` are highlighted below:
179-
180-
```SCSS
181-
// _variables.scss, LINES 56 -> 63
182-
$primary: #e91e63 !default; // EDIT & Recompile SCSS
183-
$secondary: #7b809a !default; // EDIT & Recompile SCSS
184-
$info: #1A73E8 !default; // EDIT & Recompile SCSS
185-
$success: #4CAF50 !default; // EDIT & Recompile SCSS
186-
$warning: #fb8c00 !default; // EDIT & Recompile SCSS
187-
$danger: #F44335 !default; // EDIT & Recompile SCSS
188-
$light: $gray-200 !default; // EDIT & Recompile SCSS
189-
$dark: $h-color !default; // EDIT & Recompile SCSS
190-
```
191-
192-
<br />
193-
194-
## [PRO Version](https://appseed.us/product/material-dashboard2-pro/django/)
195-
196-
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.
197-
`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.
198-
199-
> Features:
200-
201-
- `Up-to-date Dependencies`
202-
- UI Theme: `Material2 PRO`
203-
- can be used in any Django project (new or legacy)
204-
- `Sections` covered by the design:
205-
- **Admin section** (reserved for superusers)
206-
- **Authentication**: `Django.contrib.AUTH`, Registration
207-
- **All Pages** available in for ordinary users
208-
- `Docker`, `Deployment`:
209-
- `CI/CD` flow via `Render`
210-
211-
<br />
212-
213-
![Material Dashboard 2 Pro](https://user-images.githubusercontent.com/51070104/211141418-6b7886eb-6fb3-433e-91c9-2895c086099a.png)
22+
![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)
21423

21524
<br />
21625

21726
---
218-
**[Django Admin Material](https://appseed.us/product/material-dashboard/django/)** - Modern Admin Interface provided by **[AppSeed](https://appseed.us/)**
27+
**[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)**

Diff for: ‎setup.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
setup(
1010
name='django-admin-material-dashboard',
11-
version='1.0.11',
11+
version='1.0.12',
1212
zip_safe=False,
1313
packages=find_packages(),
1414
include_package_data=True,

0 commit comments

Comments
 (0)