Skip to content

Commit 1f152b7

Browse files
app-generatorapp-generator
committed
Release v1.0.6 - DOCS & Settings Update
1 parent bf32cc5 commit 1f152b7

File tree

4 files changed

+107
-3
lines changed

4 files changed

+107
-3
lines changed

‎CHANGELOG.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
11
# Change Log
22

3+
## [1.0.6] 2023-01-29
4+
### Changes
5+
6+
- DOCS Update (readme). New sections:
7+
- `How to customize the theme`
8+
- Render deployment
9+
- Configure the project to use `home/templates`
10+
- Added `custom_footer` sample
11+
312
## [1.0.5] 2023-01-01
413
### Changes
514

‎README.md‎

Lines changed: 70 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# [Soft Dashboard PRO Django](https://appseed.us/product/soft-ui-dashboard-pro/django/)
22

3-
**Django** starter styled with **[Soft Dashboard PRO](https://appseed.us/product/soft-ui-dashboard-pro/django/)**, a premium `Bootstrap 5` KIT from [Creative-Tim](https://bit.ly/3fKQZaL)
3+
**Django** starter styled with **[Soft Dashboard PRO](https://appseed.us/product/soft-ui-dashboard-pro/django/)**, a premium `Bootstrap 5` KIT from [Creative-Tim](https://bit.ly/3fKQZaL).
44
The product is designed to deliver the best possible user experience with highly customizable feature-rich pages.
55

66
> **NOTE**: This product `requires a License` in order to access the theme. During the purchase, a `GitHub Access TOKEN` is provided.
@@ -102,6 +102,74 @@ At this point, the app runs at `http://127.0.0.1:8000/`.
102102

103103
<br />
104104

105+
## How to Customize
106+
107+
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.
108+
The theme used to style this starter provides the following files:
109+
110+
```bash
111+
< LIBRARY_ROOT > # This exists in ENV: LIB/admin_soft_pro
112+
|
113+
|-- templates/ # Root Templates Folder
114+
| |
115+
| |-- accounts/
116+
| | |-- signin/basic.html # Sign IN Page
117+
| | |-- signup/basic.html # Sign UP Page
118+
| |
119+
| |-- includes/
120+
| | |-- footer.html # Footer component
121+
| | |-- sidebar.html # Sidebar component
122+
| | |-- navigation.html # Navigation Bar
123+
| | |-- scripts.html # Scripts Component
124+
| |
125+
| |-- layouts/
126+
| | |-- base.html # Masterpage
127+
| | |-- base-fullscreen.html # Masterpage for Auth Pages
128+
| |
129+
| |-- pages/
130+
| |-- widgets.html # Widgets page
131+
| |-- messages.html # Messaging APP Page
132+
| |-- *.html # All other pages
133+
|
134+
|-- ************************************************************************
135+
```
136+
137+
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.
138+
139+
> For instance, if we want to **customize the footer.html** these are the steps:
140+
141+
- ✅ `Step 1`: create the `templates` DIRECTORY inside the `home` app
142+
- ✅ `Step 2`: configure the project to use this new template directory
143+
- `core/settings.py` TEMPLATES section
144+
- ✅ `Step 3`: copy the `footer.html` from the original location (inside your ENV) and save it to the `home/templates` DIR
145+
- Source PATH: `<YOUR_ENV>/LIB/admin_soft_pro/includes/footer.html`
146+
- Destination PATH: `<PROJECT_ROOT>home/templates/includes/footer.html`
147+
148+
> To speed up all these steps, the **codebase is already configured** (`Steps 1, and 2`) and a `custom footer` can be found at this location:
149+
150+
`home/templates/includes/custom_footer.html`
151+
152+
By default, this file is unused because the `theme` expects `footer.html` (without the `custom_` prefix).
153+
154+
In order to use it, simply rename it to `footer.html`. Like this, the default version shipped in the library is ignored by Django.
155+
156+
In a similar way, all other files and components can be customized easily.
157+
158+
<br />
159+
160+
## Deploy on [Render](https://render.com/)
161+
162+
- Create a Blueprint instance
163+
- Go to https://dashboard.render.com/blueprints this link.
164+
- Click `New Blueprint Instance` button.
165+
- Connect your `repo` which you want to deploy.
166+
- Fill the `Service Group Name` and click on `Update Existing Resources` button.
167+
- After that your deployment will start automatically.
168+
169+
At this point, the product should be LIVE.
170+
171+
<br />
172+
105173
## Screenshots
106174

107175
![Django Admin Soft PRO - Main dashboard page, dark-mode ready.](https://user-images.githubusercontent.com/51070104/211251678-0ff9390a-2035-4cb3-b07d-62fa23f908d3.jpg)
@@ -121,4 +189,4 @@ At this point, the app runs at `http://127.0.0.1:8000/`.
121189
<br />
122190

123191
---
124-
**[Django Admin Soft PRO](https://appseed.us/product/soft-ui-dashboard-pro/django/)** - Modern Admin Interface provided by **[AppSeed](https://appseed.us/)**
192+
**[Soft Dashboard PRO Django](https://appseed.us/product/soft-ui-dashboard-pro/django/)** - Modern Admin Interface provided by **[AppSeed](https://appseed.us/)**

‎core/settings.py‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,10 +63,12 @@
6363

6464
ROOT_URLCONF = "core.urls"
6565

66+
HOME_TEMPLATES = os.path.join(BASE_DIR, 'home', 'templates')
67+
6668
TEMPLATES = [
6769
{
6870
"BACKEND": "django.template.backends.django.DjangoTemplates",
69-
"DIRS": [],
71+
"DIRS": [HOME_TEMPLATES],
7072
"APP_DIRS": True,
7173
"OPTIONS": {
7274
"context_processors": [

‎home/templates/includes/sample_footer.html‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
<footer class="footer pt-3 ">
2+
<div class="container-fluid">
3+
<div class="row align-items-center justify-content-lg-between">
4+
<div class="col-lg-6 mb-lg-0 mb-4">
5+
<div class="copyright text-center text-sm text-muted text-lg-start">
6+
&copy; Your company here.
7+
</div>
8+
</div>
9+
<div class="col-lg-6">
10+
<ul class="nav nav-footer justify-content-center justify-content-lg-end">
11+
<li class="nav-item">
12+
<a href="#" class="nav-link text-muted">LINK_1</a>
13+
</li>
14+
<li class="nav-item">
15+
<a href="#" class="nav-link text-muted">LINK_2</a>
16+
</li>
17+
<li class="nav-item">
18+
<a href="https://appseed.us/support/"
19+
class="nav-link text-muted" target="_blank">Support</a>
20+
</li>
21+
</ul>
22+
</div>
23+
</div>
24+
</div>
25+
</footer>

0 commit comments

Comments
 (0)