Release v1.0.14

app-generator · Jan 29, 2023 · 9da888b · 9da888b
1 parent 1cb7afd
commit 9da888b
Show file tree

Hide file tree

Showing 5 changed files with 136 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,15 @@
 # Change Log
 
+## [1.0.14] 2023-01-28
+### Changes
+
+- Bump Design: [Django Admin Soft](https://github.com/app-generator/django-admin-soft-dashboard) `v1.0.8`
+- DOCS Update (readme). New sections:
+  - `How to customize the theme`
+  - Render deployment
+- Configure the project to use `home/templates`
+- Added `custom_footer` sample
+
 ## [1.0.13] 2023-01-09
 ### Changes
 

diff --git a/README.md b/README.md
@@ -72,6 +72,104 @@ At this point, the app runs at `http://127.0.0.1:8000/`.
 
 <br />
 
+## Codebase structure
+
+The project is coded using a simple and intuitive structure presented below:
+
+```bash
+< PROJECT ROOT >
+   |
+   |-- core/                            
+   |    |-- settings.py                  # Project Configuration  
+   |    |-- urls.py                      # Project Routing
+   |
+   |-- home/
+   |    |-- views.py                     # APP Views 
+   |    |-- urls.py                      # APP Routing
+   |    |-- models.py                    # APP Models 
+   |    |-- tests.py                     # Tests  
+   |    |-- templates/                   # Theme Customisation 
+   |         |-- includes                # 
+   |              |-- custom-footer.py   # Custom Footer      
+   |     
+   |-- requirements.txt                  # Project Dependencies
+   |
+   |-- env.sample                        # ENV Configuration (default values)
+   |-- manage.py                         # Start the app - Django default start script
+   |
+   |-- ************************************************************************
+```
+
+<br />
+
+## How to Customize 
+
+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. 
+The theme used to style this starter provides the following files: 
+
+```bash
+< LIBRARY_ROOT >                      # This exists in ENV: LIB/admin_soft
+   |
+   |-- 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-fullscreen.html # Masterpage for Auth Pages
+   |    |
+   |    |-- pages/       
+   |         |-- index.html           # Dashboard page
+   |         |-- profile.html         # Settings  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 the `home` app
+- ✅ `Step 2`: configure the project to use this new template directory
+  - `core/settings.py` TEMPLATES section
+- ✅ `Step 3`: copy the `footer.html` from the original location (inside your ENV) and save it to the `home/templates` DIR
+  - Source PATH: `<YOUR_ENV>/LIB/admin_soft/includes/footer.html`
+  - Destination PATH: `<PROJECT_ROOT>home/templates/includes/footer.html`
+
+> 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:
+
+`home/templates/includes/custom_footer.html` 
+
+By default, this file is unused because the `theme` expects `footer.html` (without the `custom_` prefix). 
+
+In order to use it, simply rename it to `footer.html`. Like this, the default version shipped in the library is ignored by Django. 
+
+In a similar way, all other files and components can be customized easily.
+
+<br />
+
+## Deploy on [Render](https://render.com/)
+
+- Create a Blueprint instance
+  - Go to https://dashboard.render.com/blueprints this link.
+- Click `New Blueprint Instance` button.
+- Connect your `repo` which you want to deploy.
+- Fill the `Service Group Name` and click on `Update Existing Resources` button.
+- After that your deployment will start automatically.
+
+At this point, the product should be LIVE.
+
+<br />
+
 ## [PRO Version](https://appseed.us/product/soft-ui-dashboard-pro/django/)   
 
 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.

diff --git a/core/settings.py b/core/settings.py
@@ -63,10 +63,12 @@
 
 ROOT_URLCONF = "core.urls"
 
+HOME_TEMPLATES = os.path.join(BASE_DIR, 'home', 'templates')
+
 TEMPLATES = [
     {
         "BACKEND": "django.template.backends.django.DjangoTemplates",
-        "DIRS": [],
+        "DIRS": [HOME_TEMPLATES],
         "APP_DIRS": True,
         "OPTIONS": {
             "context_processors": [

diff --git a/home/templates/includes/sample_footer.html b/home/templates/includes/sample_footer.html
@@ -0,0 +1,24 @@
+<footer class="footer pt-3  ">
+  <div class="container-fluid">
+    <div class="row align-items-center justify-content-lg-between">
+      <div class="col-lg-6 mb-lg-0 mb-4">
+        <div class="copyright text-center text-sm text-muted text-lg-start">
+          &copy; Your Company HERE.
+        </div>
+      </div>
+      <div class="col-lg-6">
+        <ul class="nav nav-footer justify-content-center justify-content-lg-end">
+          <li class="nav-item">
+            <a href="#" class="nav-link text-muted">LINK_1</a>
+          </li>
+          <li class="nav-item">
+            <a href="#" class="nav-link text-muted">LINK_2</a>
+          </li>
+          <li class="nav-item">
+            <a href="https://appseed.us/support/" class="nav-link text-muted" target="_blank">Support</a>
+          </li>
+        </ul>
+      </div>
+    </div>
+  </div>
+</footer>
diff --git a/requirements.txt b/requirements.txt
@@ -2,7 +2,7 @@ django
 gunicorn
 python-dotenv
 whitenoise
-django-admin-soft-dashboard==1.0.7
+django-admin-soft-dashboard==1.0.8
 
 # psycopg2-binary
 # mysqlclient