Release v1.0.9 - DOCS Update & Links Curation

app-generator · Jan 31, 2023 · 6c4b065 · 6c4b065
1 parent 6bb6379
commit 6c4b065
Show file tree

Hide file tree

Showing 4 changed files with 65 additions and 10 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,11 @@
 # CHANGELOG
 
+## [1.0.9] 2023-01-31
+### Changes
+
+- Links curation
+- DOCS Update
+
 ## [1.0.8] 2023-01-23
 ### Changes
 

diff --git a/README.md b/README.md
@@ -8,7 +8,7 @@ Modern template for **Django** that covers `Admin Section`, all authentication p
 
 **Links & Resources**
 
-- [Django Admin Volt](https://appseed.us/product/volt-dashboard/django/) - `Product page`
+- [Django Admin Volt](https://appseed.us/product/volt-dashboard/django/) - `Product` that uses the library
   - `Features`: Fully-configured, `CI/CD` via Render
 - UI Kit: Volt Dashboard BS5 `v1.4.1` by Themesberg
 - **Sections Covered**: 
@@ -107,6 +107,57 @@ Access the `admin` section in the browser: `http://127.0.0.1:8000/`
 
 <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
+# This exists in ENV: LIB/admin_volt
+< UI_LIBRARY_ROOT >                      
+   |
+   |-- templates/                     # Root Templates Folder 
+   |    |          
+   |    |-- accounts/       
+   |    |    |-- sign-in.html         # Sign IN Page
+   |    |    |-- sign-up.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-auth.html       # Masterpage for Auth Pages
+   |    |
+   |    |-- pages/       
+   |         |-- index.html           # Dashboard Page
+   |         |-- settings.html        # Profile 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 your app 
+- `Step 2`: configure the project to use this new template directory
+  - Edit `settings.py` TEMPLATES section 
+- `Step 3`: copy the `footer.html` from the original location (inside your ENV) and save it to the `YOUR_APP/templates` DIR
+  - Source PATH: `<YOUR_ENV>/LIB/admin_volt/includes/footer.html`
+  - Destination PATH: `YOUR_APP/templates/includes/footer.html`
+- Edit the footer (Destination PATH)    
+
+At this point, the default version of the `footer.html` shipped in the library is ignored by Django.
+
+In a similar way, all other files and components can be customized easily.
+
+<br />
+
 ## [PRO Version](https://appseed.us/product/volt-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. `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.

diff --git a/admin_volt/templates/includes/footer.html b/admin_volt/templates/includes/footer.html
@@ -1,23 +1,21 @@
 <footer class="bg-white rounded shadow p-5 mb-4 mt-4">
   <div class="row">
     <div class="col-12 col-md-4 col-xl-6 mb-4 mb-md-0">
-      <p class="mb-0 text-center text-lg-start">© 2019-<span class="current-year"></span> <a
-          class="text-primary fw-normal" href="https://themesberg.com" target="_blank">Themesberg</a></p>
+      <p class="mb-0 text-center text-lg-start">
+        &copy; Themesberg - coded by AppSeed.
+      </p>
     </div>
     <div class="col-12 col-md-8 col-xl-6 text-center text-lg-start">
       <!-- List -->
       <ul class="list-inline list-group-flush list-group-borderless text-md-end mb-0">
         <li class="list-inline-item px-0 px-sm-2">
-          <a href="https://themesberg.com/about">About</a>
+          <a href="https://appseed.us/product/volt-dashboard/django/" target="_blank">Download</a>
         </li>
         <li class="list-inline-item px-0 px-sm-2">
-          <a href="https://themesberg.com/themes">Themes</a>
+          <a href="https://appseed.us/product/volt-dashboard-pro/django/" target="_blank">PRO Version</a>
         </li>
         <li class="list-inline-item px-0 px-sm-2">
-          <a href="https://themesberg.com/blog">Blog</a>
-        </li>
-        <li class="list-inline-item px-0 px-sm-2">
-          <a href="https://themesberg.com/contact">Contact</a>
+          <a href="https://appseed.us/support/" target="_blank">Support</a>
         </li>
       </ul>
     </div>

diff --git a/setup.py b/setup.py
@@ -8,7 +8,7 @@
 
 setup(
 name='django-admin-volt',
-version='1.0.8',
+version='1.0.9',
 zip_safe=False,
 packages=find_packages(),
 include_package_data=True,