Release v1.0.6 - DOCS Update

app-generator · Feb 13, 2023 · acb887c · acb887c
1 parent 9531006
commit acb887c
Show file tree

Hide file tree

Showing 2 changed files with 67 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,21 @@
 # CHANGELOG
 
+## [1.0.6] 2023-02-13
+### Changes
+
+- Update DOCS (readme) 
+
+## [1.0.5] 2023-02-13
+### Changes
+
+- Fix missing assets 
+  - Remove `dist` from `.gitignore`
+
+## [1.0.4] 2023-02-13
+### Changes
+
+- Fix missing assets 
+
 ## [1.0.3] 2023-01-25
 ### Changes
 

diff --git a/README.md b/README.md
@@ -109,5 +109,56 @@ Access the `admin` section in the browser: `http://127.0.0.1:8000/`
 
 <br />
 
+## How to Customize 
+
+When a template file is loaded, `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_argon_pro
+< UI_LIBRARY_ROOT >                      
+   |
+   |-- 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-auth.html       # Masterpage for Auth Pages
+   |    |
+   |    |-- pages/       
+   |         |-- index.html           # Dashboard Page
+   |         |-- profile.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_argon_pro/templates/includes/footer.html`
+  - Destination PATH: `YOUR_APP/templates/includes/footer.html`
+- Edit the `footer.html` (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 />
+
 ---
 **[Django Admin Argon PRO](https://appseed.us/product/argon-dashboard-pro/django/)** - Modern Admin Interface provided by **[AppSeed](https://appseed.us/)**