Skip to content

Commit 29b0e12

Browse files
committed
Update README.md
1 parent 1f152b7 commit 29b0e12

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,36 @@ At this point, the app runs at `http://127.0.0.1:8000/`.
102102

103103
<br />
104104

105+
## Codebase structure
106+
107+
The project is coded using a simple and intuitive structure presented below:
108+
109+
```bash
110+
< PROJECT ROOT >
111+
|
112+
|-- core/
113+
| |-- settings.py # Project Configuration
114+
| |-- urls.py # Project Routing
115+
|
116+
|-- home/
117+
| |-- views.py # APP Views
118+
| |-- urls.py # APP Routing
119+
| |-- models.py # APP Models
120+
| |-- tests.py # Tests
121+
| |-- templates/ # Theme Customisation
122+
| |-- includes #
123+
| |-- custom-footer.py # Custom Footer
124+
|
125+
|-- requirements.txt # Project Dependencies
126+
|
127+
|-- env.sample # ENV Configuration (default values)
128+
|-- manage.py # Start the app - Django default start script
129+
|
130+
|-- ************************************************************************
131+
```
132+
133+
<br />
134+
105135
## How to Customize
106136

107137
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.

0 commit comments

Comments
 (0)