File Structure
Metronic Django comes with a flexible file structure that can be easily used for small to large scope projects.
This section will explain the entire file structure and how to adapt it to your project.
| File/Folder | Description |
|---|---|
starterkit
|
The root folder that contains Metronic Django folder. |
_keenthemes
|
This is a Core Django for Keenthemes products. |
libs
|
Metronic library which is often used for common files, utility classes, imported dependencies |
src
|
The source folder which located the raw version of HTML templates. The assets will be used for assets bundling. |
templatetags
|
Template Tags are simple Python functions which accepts a 1 or more value, an optional argument, process those values and return a value to be displayed on the page. |
tools
|
The build tools for assets. |
__init__.py
|
The __init__.py files are required to make Python treat the directories as containing packages |
asgi.py
|
ASGI (Asynchronous Server Gateway Interface) provides an interface between async Python web servers and applications while it supports all the features provided by WSGI. |
bootstrap.py
|
Combine the necessary bits in the framework together to be able to process and handle the functionality thrown at the system. |
settings.py
|
settings.py is a core file in Django projects. It holds all the configuration values that your web app needs to work; database settings, logging configuration, where to find static files, API keys if you work with external APIs, and a bunch of other stuff. |
urls.py
|
It's where you define the mapping between URLs and views. |
wsgi.py
|
Django's primary deployment platform is WSGI, the Python standard for web servers and applications. |
_locale
|
Specify which parts of apps should be translated or formatted for local languages and cultures. |
_templates
|
Text document or a Python string marked-up using the Django template language. |
auth
|
Example auth HTML markup template files. |
dashboards
|
Example dashboard HTML markup template files. |
layout
|
Contains the base layout files. |
partials
|
Contains partial files. |
assets
|
An asset is typically a static file such as JS files, image files, CSS files. A bundle is when those files are then compressed together into a single file. |
auths
|
Example auth module and pages |
dashboards
|
Example dashboard module and pages |
db.sqlite3
|
Generated database file. |
manage.py
|
Manage.py in Django is a command-line utility that works similar to the django-admin command. |
.gitignore
|
A gitignore file specifies intentionally untracked files that Git should ignore. Files already tracked by Git are not affected |
documentation.html
|
The documentation file. |
README.md
|
README file as a quick guide that gives a detailed description |
2024©
Keenthemes
