Release v1.0.11 - DOCS Update & Bump UI

app-generator · Jan 31, 2023 · aa39cae · aa39cae
1 parent ccb5587
commit aa39cae
Show file tree

Hide file tree

Showing 4 changed files with 44 additions and 6 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,12 @@
 # Change Log
 
+## [1.0.11] 2023-01-31
+### Changes
+
+- DOCS Update (readme)
+- Bump design version:
+   - [Django Admin Volt](https://github.com/app-generator/django-admin-volt) `v1.0.9`
+
 ## [1.0.10] 2023-01-28
 ### Changes
 

diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # [Volt Dashboard Django](https://appseed.us/product/volt-dashboard/django/)
 
-Open-source **Django Dashboard** generated by `AppSeed` on top of a modern design. **[Volt Dashboard](https://appseed.us/product/volt-dashboard/django/)** is a free and open source `Bootstrap 5` Admin Dashboard featuring over 100 components, 11 example pages and 3 plugins with Vanilla JS. There are more than 100 free Bootstrap 5 components included some of them being buttons, alerts, modals, and datepickers.
+Open-source **Django Dashboard** built on top of a modern design. **[Volt Dashboard](https://appseed.us/product/volt-dashboard/django/)** is a free and open source `Bootstrap 5` Admin Dashboard featuring over 100 components, 11 example pages and 3 plugins with Vanilla JS. There are more than 100 free Bootstrap 5 components included some of them being buttons, alerts, modals, and datepickers.
 
 - 👉 [Volt Dashboard Django](https://appseed.us/product/volt-dashboard/django/) - Product page
 - 👉 [Volt Dashboard Django](https://django-volt-dashboard.appseed-srv1.com/) - LIVE Demo
@@ -70,13 +70,44 @@ 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_volt
+# This exists in ENV: LIB/admin_volt
+< UI_LIBRARY_ROOT >                     
    |
    |-- templates/                    # Root Templates Folder 
    |    |          
@@ -118,7 +149,7 @@ When the project requires customization, we need to copy the original file that
 
 `home/templates/includes/custom_footer.html` 
 
-By default, this file is unused because the `theme` expects `footer.html` (without the `custom_` prefix). 
+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. 
 
@@ -162,4 +193,4 @@ This design is a pixel-perfect [Bootstrap 5](https://www.admin-dashboards.com/bo
 <br />
 
 ---
-[Django Volt Dashboard](https://appseed.us/product/volt-dashboard/django/) - Minimal **Django** core provided by **[AppSeed](https://appseed.us/)**
+[Django Volt Dashboard](https://appseed.us/product/volt-dashboard/django/) - **Django** starter provided by **[AppSeed](https://appseed.us/)**
diff --git a/home/templates/includes/custom_footer.html → home/templates/includes/custom-footer.html b/home/templates/includes/custom_footer.html → home/templates/includes/custom-footer.html
@@ -2,7 +2,7 @@
   <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">
-        &copy; Your Company
+        &copy; Your Company HERE
       </p>
     </div>
     <div class="col-12 col-md-8 col-xl-6 text-center text-lg-start">

diff --git a/requirements.txt b/requirements.txt
@@ -2,7 +2,7 @@ django
 gunicorn
 python-dotenv
 whitenoise
-django-admin-volt==1.0.8
+django-admin-volt==1.0.9
 
 # psycopg2-binary
 # mysqlclient