Skip to content

Commit e662968

Browse files
committed
UPDATE Docs
1 parent fea0615 commit e662968

File tree

1 file changed

+99
-0
lines changed

1 file changed

+99
-0
lines changed

README.md

Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -101,5 +101,104 @@ At this point, the app runs at `http://127.0.0.1:8000/`.
101101

102102
<br />
103103

104+
## Codebase structure
105+
106+
The project is coded using a simple and intuitive structure presented below:
107+
108+
```bash
109+
< PROJECT ROOT >
110+
|
111+
|-- core/
112+
| |-- settings.py # Project Configuration
113+
| |-- urls.py # Project Routing
114+
|
115+
|-- home/
116+
| |-- views.py # APP Views
117+
| |-- urls.py # APP Routing
118+
| |-- models.py # APP Models
119+
| |-- tests.py # Tests
120+
| |-- templates/ # Theme Customisation
121+
| |-- includes #
122+
| |-- custom-footer.py # Custom Footer
123+
|
124+
|-- requirements.txt # Project Dependencies
125+
|
126+
|-- env.sample # ENV Configuration (default values)
127+
|-- manage.py # Start the app - Django default start script
128+
|
129+
|-- ************************************************************************
130+
```
131+
132+
<br />
133+
134+
## How to Customize
135+
136+
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.
137+
The theme used to style this starter provides the following files:
138+
139+
```bash
140+
# This exists in ENV: LIB/admin_volt_pro
141+
< UI_LIBRARY_ROOT >
142+
|
143+
|-- templates/ # Root Templates Folder
144+
| |
145+
| |-- accounts/
146+
| | |-- sign-in.html # Sign IN Page
147+
| | |-- sign-up.html # Sign UP Page
148+
| |
149+
| |-- includes/
150+
| | |-- footer.html # Footer component
151+
| | |-- sidebar.html # Sidebar component
152+
| | |-- navigation.html # Navigation Bar
153+
| | |-- scripts.html # Scripts Component
154+
| |
155+
| |-- layouts/
156+
| | |-- base.html # Masterpage
157+
| | |-- base-auth.html # Masterpage for Auth Pages
158+
| |
159+
| |-- pages/
160+
| |-- index.html # Dashboard Page
161+
| |-- settings.html # Profile Page
162+
| |-- *.html # All other pages
163+
|
164+
|-- ************************************************************************
165+
```
166+
167+
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.
168+
169+
> For instance, if we want to **customize the footer.html** these are the steps:
170+
171+
-`Step 1`: create the `templates` DIRECTORY inside the `home` app
172+
-`Step 2`: configure the project to use this new template directory
173+
- `core/settings.py` TEMPLATES section
174+
-`Step 3`: copy the `footer.html` from the original location (inside your ENV) and save it to the `home/templates` DIR
175+
- Source PATH: `<YOUR_ENV>/LIB/admin_volt_pro/templates/includes/footer.html`
176+
- Destination PATH: `<PROJECT_ROOT>home/templates/includes/footer.html`
177+
178+
> 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:
179+
180+
`home/templates/includes/custom-footer.html`
181+
182+
By default, this file is unused because the `theme` expects `footer.html` (without the `custom-` prefix).
183+
184+
In order to use it, simply rename it to `footer.html`. Like this, the default version shipped in the library is ignored by Django.
185+
186+
In a similar way, all other files and components can be customized easily.
187+
188+
<br />
189+
190+
## Deploy on [Render](https://render.com/)
191+
192+
- Create a Blueprint instance
193+
- Go to https://dashboard.render.com/blueprints this link.
194+
- Click `New Blueprint Instance` button.
195+
- Connect your `repo` which you want to deploy.
196+
- Fill the `Service Group Name` and click on `Update Existing Resources` button.
197+
- After that your deployment will start automatically.
198+
199+
At this point, the product should be LIVE.
200+
201+
<br />
202+
104203
---
105204
[Django Volt PRO](https://appseed.us/product/volt-dashboard-pro/django/) - **Django** starter provided by **[AppSeed](https://appseed.us/)**

0 commit comments

Comments
 (0)