|
1 | 1 | # [Django Theme Soft Design](https://appseed.us/product/soft-ui-design/django/) |
2 | 2 |
|
3 | | -Modern Theme for **Django** that covers authentication pages (registration included) crafted on top of **[Material Kit](https://appseed.us/product/soft-ui-design/django/)**, an open-source `Bootstrap 5` design from `Creative-Tim`. |
| 3 | +Modern Theme for **Django** that covers authentication pages (registration included) crafted on top of **[Soft UI Design](https://appseed.us/product/soft-ui-design/django/)**, an open-source `Bootstrap 5` design from [Creative-Tim](https://www.creative-tim.com/?AFFILIATE=128200). |
4 | 4 |
|
5 | 5 | > Actively supported by [AppSeed](https://appseed.us/) via `Email` and `Discord`. |
6 | 6 |
|
7 | 7 | <br> |
8 | 8 |
|
9 | 9 | **Links & Resources** |
10 | 10 |
|
11 | | -- [Django Theme Soft Design](https://appseed.us/product/soft-ui-design/django/) - `Product page` |
| 11 | +- [Django Soft Design](https://appseed.us/product/soft-ui-design/django/) - `Product page` |
12 | 12 | - `Features`: Fully-configured, `CI/CD` via Render |
13 | | -- UI Kit: `Soft UI Desig` (Bootstrap 5) by Creative-Tim |
| 13 | +- UI Kit: [Soft Design System](https://www.creative-tim.com/product/soft-ui-design-system?AFFILIATE=128200) (Bootstrap 5) by `Creative-Tim` |
14 | 14 | - **Sections Covered**: |
15 | 15 | - `All pages` managed by `Django.contrib.AUTH` |
16 | 16 | - `Registration` page |
@@ -109,9 +109,58 @@ $ python manage.py runserver # default port 8000 |
109 | 109 |
|
110 | 110 | <br /> |
111 | 111 |
|
| 112 | +## How to Customize |
| 113 | + |
| 114 | +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. |
| 115 | +The theme used to style this starter provides the following files: |
| 116 | + |
| 117 | +```bash |
| 118 | +# This exists in ENV: LIB/theme_soft_design |
| 119 | +< UI_LIBRARY_ROOT > |
| 120 | + | |
| 121 | + |-- templates/ # Root Templates Folder |
| 122 | + | | |
| 123 | + | |-- accounts/ |
| 124 | + | | |-- sign-in.html # Sign IN Page |
| 125 | + | | |-- sign-up.html # Sign UP Page |
| 126 | + | | |
| 127 | + | |-- includes/ |
| 128 | + | | |-- footer.html # Footer component |
| 129 | + | | |-- navigation.html # Navigation Bar |
| 130 | + | | |-- scripts.html # Scripts Component |
| 131 | + | | |
| 132 | + | |-- layouts/ |
| 133 | + | | |-- base.html # Masterpage |
| 134 | + | | |
| 135 | + | |-- pages/ |
| 136 | + | |-- index.html # Dashboard Page |
| 137 | + | |-- author.html # Profile Page |
| 138 | + | |-- *.html # All other pages |
| 139 | + | |
| 140 | + |-- ************************************************************************ |
| 141 | +``` |
| 142 | + |
| 143 | +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. |
| 144 | + |
| 145 | +For instance, if we want to customize the `index.html` these are the steps: |
| 146 | + |
| 147 | +- `Step 1`: create the `templates` DIRECTORY inside your app |
| 148 | +- `Step 2`: configure the project to use this new template directory |
| 149 | + - Edit `settings.py` TEMPLATES section |
| 150 | +- `Step 3`: copy the `index.html` from the original location (inside your ENV) and save it to the `YOUR_APP/templates` DIR |
| 151 | + - Source PATH: `<YOUR_ENV>/LIB/theme_soft_design/templates/pages/index.html` |
| 152 | + - Destination PATH: `YOUR_APP/templates/pages/index.html` |
| 153 | +- Edit the `index.html` (Destination PATH) |
| 154 | + |
| 155 | +At this point, the default version of the `index.html` shipped in the library is ignored by Django. |
| 156 | + |
| 157 | +In a similar way, all other files and components can be customized easily. |
| 158 | + |
| 159 | +<br /> |
| 160 | + |
112 | 161 | ## [PRO Version](https://appseed.us/product/soft-ui-design-pro/django/) |
113 | 162 |
|
114 | | -**Material Kit 2** is a premium design crafted by the `Creative-Tim` agency on top of Bootstrap 5 Framework. Designed for those who like bold elements and beautiful websites, Material Kit 2 is made of hundreds of elements, designed blocks, and fully coded pages built with an impressive level of quality. |
| 163 | +**Soft UI Design** is a premium design crafted by the `Creative-Tim` agency on top of Bootstrap 5 Framework. Designed for those who like bold elements and beautiful websites, **Soft Design PRO** is made of hundreds of elements, designed blocks, and fully coded pages built with an impressive level of quality. |
115 | 164 |
|
116 | 165 | - [Django Soft Design PRO](https://appseed.us/product/soft-ui-design-pro/django/) - product page |
117 | 166 | - `Enhanced UI` - more pages and components |
|
0 commit comments