Documentation

Ctrl+K

File Structure

Here is the general file structure of the template:

  • Template
    • gulp+scss+hbs
      • src
        • assets
          • images
            • icon.png
            • favicon.ico
            • loader.gif
          • js
            • charts
            • customizer
            • plugins
            • hope-ui.js
            • hope-uipro.js
            • all js which are used globally
          • modules
            • modules explanation is given bellow
          • scss
            • bootstrap
              • forms
              • helper
              • mixins
              • utilites
              • vendor
            • custom
              • All custome scss
            • customizer
              • All files & folder regarding color customizer
            • dark
              • All files & folder regarding dark mode
            • hope-ui-design-system
              • components
                • All components files and folder
              • helper
                • All mixins and utilities files and folder
              • layout-style
                • layout regarding menu style
              • plugins
                • All plugins scss
              • variables
                • All files and folder of particular elements
              • variables.scss
            • pro
              • All files & folder regarding plugins, auth, etc...
            • rtl
              • All files & folder regarding RTL mode
            • custom.scss
            • customizer.scss
            • dark.scss
            • hope-ui.scss
            • pro.scss
            • rtl.scss
          • vendor
            • all third party plugins files
        • templates
          • components
            • partials
              • all components which repeat continiously in all page. e.g. sidebar, header, footer, etc.
            • widgets
              • Widgets that are used globally in the dashboard. e.g. profile card in dashboard's sidebar.
          • layout
            • all layout regarding dashboards
          • modules
            • modules explanation is given bellow
          • pages
            • all folders based on hbs file in the dashboard.
      • gulp
        • all gulp task here
      • gulp.config.json
      • gulpfile.js
      • package.json
    • html
      • assets
        • css
        • images
        • js
        • vendor
      • appointment
        • assets
          • css
            • all css files
          • images
            • images regarding this modules
          • js
            • all js files
        • all pages regarding dashboard
      • blog
        • same as appointment module
      • chat
        • same as appointment module
      • e-commerce
        • same as appointment module
      • file-manager
        • same as appointment module
      • mail
        • same as appointment module
      • social-app
        • same as appointment module

Modules

Modules folder structure in assets folder.

  • Template
    • gulp+scss+hbs
      • src
        • assets
          • images
          • js
          • modules
            • appointment
              • images
                • All images regarding this modules
              • js
                • All js regarding this modules
              • scss
                • All scss regarding this modules
            • blog
              • images, scss, js all files
            • chat
              • images, scss, js all files
            • e-commerce
              • images, scss, js all files
            • file-manager
              • images, scss, js all files
            • mail
              • images, scss, js all files
            • social-app
              • images, scss, js all files
          • scss
          • vendor

Modules folder structure in src -> templates -> modules folder.

  • Template
    • gulp+scss+hbs
      • src
        • assets
        • templates
          • components
          • layouts
          • modules
            • appointment
              • components
                • partials
                  • sidebar, css, js components regarding this dashboard will get here
                • widgets
                  • widgets regarding this dashboard will get here
              • layout
                • layout regarding this dashboard
              • pages
                • All pages regarding this dashboard
            • blog
              • same as appointment module
            • chat
              • same as appointment module
            • e-commerce
              • same as appointment module
            • file-manager
              • same as appointment module
            • mail
              • same as appointment module
            • social-app
              • same as appointment module
          • pages