Skip to content

Commit 6c4b065

Browse files
app-generatorapp-generator
committed
Release v1.0.9 - DOCS Update & Links Curation
1 parent 6bb6379 commit 6c4b065

File tree

4 files changed

+65
-10
lines changed

4 files changed

+65
-10
lines changed

‎CHANGELOG.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
# CHANGELOG
22

3+
## [1.0.9] 2023-01-31
4+
### Changes
5+
6+
- Links curation
7+
- DOCS Update
8+
39
## [1.0.8] 2023-01-23
410
### Changes
511

‎README.md‎

Lines changed: 52 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Modern template for **Django** that covers `Admin Section`, all authentication p
88

99
**Links & Resources**
1010

11-
- [Django Admin Volt](https://appseed.us/product/volt-dashboard/django/) - `Product page`
11+
- [Django Admin Volt](https://appseed.us/product/volt-dashboard/django/) - `Product` that uses the library
1212
- `Features`: Fully-configured, `CI/CD` via Render
1313
- UI Kit: Volt Dashboard BS5 `v1.4.1` by Themesberg
1414
- **Sections Covered**:
@@ -107,6 +107,57 @@ Access the `admin` section in the browser: `http://127.0.0.1:8000/`
107107

108108
<br />
109109

110+
## How to Customize
111+
112+
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.
113+
The theme used to style this starter provides the following files:
114+
115+
```bash
116+
# This exists in ENV: LIB/admin_volt
117+
< UI_LIBRARY_ROOT >
118+
|
119+
|-- templates/ # Root Templates Folder
120+
| |
121+
| |-- accounts/
122+
| | |-- sign-in.html # Sign IN Page
123+
| | |-- sign-up.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+
| |-- settings.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_volt/includes/footer.html`
152+
- Destination PATH: `YOUR_APP/templates/includes/footer.html`
153+
- Edit the footer (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+
110161
## [PRO Version](https://appseed.us/product/volt-dashboard-pro/django/)
111162

112163
This design is a pixel-perfect [Bootstrap 5](https://www.admin-dashboards.com/bootstrap-5-templates/) Dashboard with a fresh, new design. `Volt 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.

‎admin_volt/templates/includes/footer.html‎

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,21 @@
11
<footer class="bg-white rounded shadow p-5 mb-4 mt-4">
22
<div class="row">
33
<div class="col-12 col-md-4 col-xl-6 mb-4 mb-md-0">
4-
<p class="mb-0 text-center text-lg-start">© 2019-<span class="current-year"></span> <a
5-
class="text-primary fw-normal" href="https://themesberg.com" target="_blank">Themesberg</a></p>
4+
<p class="mb-0 text-center text-lg-start">
5+
&copy; Themesberg - coded by AppSeed.
6+
</p>
67
</div>
78
<div class="col-12 col-md-8 col-xl-6 text-center text-lg-start">
89
<!-- List -->
910
<ul class="list-inline list-group-flush list-group-borderless text-md-end mb-0">
1011
<li class="list-inline-item px-0 px-sm-2">
11-
<a href="https://themesberg.com/about">About</a>
12+
<a href="https://appseed.us/product/volt-dashboard/django/" target="_blank">Download</a>
1213
</li>
1314
<li class="list-inline-item px-0 px-sm-2">
14-
<a href="https://themesberg.com/themes">Themes</a>
15+
<a href="https://appseed.us/product/volt-dashboard-pro/django/" target="_blank">PRO Version</a>
1516
</li>
1617
<li class="list-inline-item px-0 px-sm-2">
17-
<a href="https://themesberg.com/blog">Blog</a>
18-
</li>
19-
<li class="list-inline-item px-0 px-sm-2">
20-
<a href="https://themesberg.com/contact">Contact</a>
18+
<a href="https://appseed.us/support/" target="_blank">Support</a>
2119
</li>
2220
</ul>
2321
</div>

‎setup.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
setup(
1010
name='django-admin-volt',
11-
version='1.0.8',
11+
version='1.0.9',
1212
zip_safe=False,
1313
packages=find_packages(),
1414
include_package_data=True,

0 commit comments

Comments
 (0)