Skip to content

Commit 9da888b

Browse files
app-generatorapp-generator
committed
Release v1.0.14
1 parent 1cb7afd commit 9da888b

File tree

5 files changed

+136
-2
lines changed

5 files changed

+136
-2
lines changed

‎CHANGELOG.md

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

3+
## [1.0.14] 2023-01-28
4+
### Changes
5+
6+
- Bump Design: [Django Admin Soft](https://github.com/app-generator/django-admin-soft-dashboard) `v1.0.8`
7+
- DOCS Update (readme). New sections:
8+
- `How to customize the theme`
9+
- Render deployment
10+
- Configure the project to use `home/templates`
11+
- Added `custom_footer` sample
12+
313
## [1.0.13] 2023-01-09
414
### Changes
515

‎README.md

Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,104 @@ At this point, the app runs at `http://127.0.0.1:8000/`.
7272

7373
<br />
7474

75+
## Codebase structure
76+
77+
The project is coded using a simple and intuitive structure presented below:
78+
79+
```bash
80+
< PROJECT ROOT >
81+
|
82+
|-- core/
83+
| |-- settings.py # Project Configuration
84+
| |-- urls.py # Project Routing
85+
|
86+
|-- home/
87+
| |-- views.py # APP Views
88+
| |-- urls.py # APP Routing
89+
| |-- models.py # APP Models
90+
| |-- tests.py # Tests
91+
| |-- templates/ # Theme Customisation
92+
| |-- includes #
93+
| |-- custom-footer.py # Custom Footer
94+
|
95+
|-- requirements.txt # Project Dependencies
96+
|
97+
|-- env.sample # ENV Configuration (default values)
98+
|-- manage.py # Start the app - Django default start script
99+
|
100+
|-- ************************************************************************
101+
```
102+
103+
<br />
104+
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
112+
|
113+
|-- templates/ # Root Templates Folder
114+
| |
115+
| |-- accounts/
116+
| | |-- login.html # Sign IN Page
117+
| | |-- register.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+
| |-- index.html # Dashboard page
131+
| |-- profile.html # Settings 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/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+
75173
## [PRO Version](https://appseed.us/product/soft-ui-dashboard-pro/django/)
76174

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

‎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: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
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/" class="nav-link text-muted" target="_blank">Support</a>
19+
</li>
20+
</ul>
21+
</div>
22+
</div>
23+
</div>
24+
</footer>

‎requirements.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ django
22
gunicorn
33
python-dotenv
44
whitenoise
5-
django-admin-soft-dashboard==1.0.7
5+
django-admin-soft-dashboard==1.0.8
66

77
# psycopg2-binary
88
# mysqlclient

0 commit comments

Comments
 (0)