File Structure
Metronic Nodejs 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 Nodejs application.
|
_keenthemes
|
This is a Keenthemes product core folder.
|
lib
|
Folder contains theme helper files.
|
bootstrap.js
|
Contains theme core initialization functions and all layout initialization functions.
|
theme.js
|
Theme API class.
|
themesettings.json
|
Theme configuration file.
|
src
|
The source folder which located the raw version of HTML templates. The assets will be used for assets bundling.
|
tools
|
The build tools for assets.
|
public
|
Static file folder
|
assets
|
This folder contains static files required for application's front-end grouped into folders based on their type.
|
router
|
Express router files.
|
views
|
Contains page views, layout views and global partials.
|
layout
|
Contains layout files and layout partials.
|
master.js
|
Main wrapper file, all css and js files are connected in this file and layouts/pages are wrapped with this file.
|
pages
|
Contains pages views.
|
partials
|
Folder contains global theme partials.
|
.gitignore
|
A gitignore file specifies intentionally untracked files that Git should ignore. Files already tracked by Git are not affected
|
app.js
|
Application entry point file.
|
package.json
|
File contains dependencies required for appliation.
|
.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
|