File Structure

Metronic 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 Flask folder.
_keenthemes This is a Core Flask 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
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 Flask 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.
_templates Text document or a Python string marked-up using the Flask 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.
venv venv (for Python 3) allow you to manage separate package installations for different projects.
.flaskenv Easily set Flask settings from environment variables.
__init__.py The __init__.py file makes Python treat directories containing it as modules. Furthermore, this is the first file to be loaded in a module.
requirements.txt In Python requirement. txt file is a type of file that usually stores information about all the libraries, modules, and packages in itself that are used while developing a particular project. It also stores all files and packages on which that project is dependent or requires to run.
.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
Preview Get Help Buy Now