Development Guide

Documentation - v1.2

Suha - Multipurpose Ecommerce Mobile HTML Template

The Suha is a Static HTML5 Template:
We do not provide any documentation or email support on how to integrate with any CMS (such as WordPress, Joomla, etc.) or frameworks (such as Angular, Vue, React, etc.).

Get Help

Thank you for purchased our item(s). If you have any questions that are beyond the scope of this help file, please feel free to email via support page here. Thank you so much!

In some cases, you may have to wait 2 working days to get an email answer. However, we will try to answer you as soon as possible. Replies are sometimes delayed due to multiple emails and time zone variations.

Files Structure

  • Suha
    • dist (compiled distribution files)
    • node_modules (npm dependencies files. It is NOT included in the downloaded file, this folder will be installed automatically when you install npm).
    • src (all source files)
      • pug (all .pug files into this folder)
      • scss (all .scss files into this folder)
    • static (all static assets)
      • css (all static css files)
      • fonts (all static fonts files)
      • img (all images)
      • js (all static .js files)
      • manifest.json (manifest file for PWA functions)
      • service-worker.js (service worker file for PWA functions)
    • .browerslistrc
    • changelog.txt
    • gulpfile.js
    • license
    • package.json
    • package-lock.json (this file NOT included in the downloaded file, this file will be automatically created when you run gulp)

Code Editor

There are many code editors for web code editing. You can use whatever you want. We recommend that you use Visual Studio Code . Because - this template is coded using it.

Installation

It has a directory (suha/dist) of compiled files. If you want to edit without source files (plain HTML/CSS/JS files), you do not need to install anything on your machine.

You need to install package files/dependencies for this project if you want to customize it. To do this, you must have node and npm installed on your computer. Installation guide of the node can be found here.

As npm comes bundled with a node, a separate installation of npm is NOT needed. If you have installed them, just go to the root folder and run the following command in your command prompt or terminal.

npm install --legacy-peer-deps

Run Gulp

Run a command to run Gulp. When you run this command, it also watching at all source and static files. So, you don't need to run another command to watching these.

npm run gulp

If you want, just watch the source files. You can run another individual command.

npm run gulp watch

Know the file type

Source files:

Source files are files that are processed with template build tools to make the browser readable. E.g. SCSS & PUG files always source files.

Files location: suha > "src" folder

Compiled files:

Compiled files are files generated as a result of running a compilation process in the source files. E.g. CSS & standard HTML files always compiled files.

Files location: suha > "dist" folder

Static files:

Static files are ones that aren’t processed or generated. E.g. Images, Web Icon Fonts and standard HTML are static files.

Files location: suha > "static" folder

Before getting started you must read this

Before getting started with a PWA ready template, you need to know a very simple thing!
PWA (Progressive Web App) mainly works with the "service-worker.js" file. This file cache data in your browser for smoothly viewing this website when you're offline.
What is the problem with that?
When you edited the files & script and save it, your changes won't take effect until clear your browser cache.
How to solve this problem?
Please disconnect "service-worker.js" file, when you are developing your site. Find "service-worker.js" file in "static" folder > "service-worker.js". Comment on all codes or remove this file another location.
After the site has finished developing, when you are ready to upload your website to the server, then connect this file again "service-worker.js" to your project.

SCSS files

Sass stands for Syntactically Awesome Stylesheet. Sass is the most mature, stable, and powerful professional grade CSS extension language in the world. It's gives you variables, nesting, partials, modules, mixins, extend/inheritance & operators, etc.

Visit the official website to learn the details.
SCSS Files Layout
File Description
style.scss core .scss file Core stylesheet
_reboot.scss All style reboot
_preloader.scss Preloader CSS
_shortcode.scss All shortcode CSS
_demo.scss Demo page CSS
_miscellaneous.scss Miscellaneous CSS
_header.scss Header css
_footer.scss Footer css
_register.scss Login/Register page CSS
_sidenav.scss Sidenav CSS
_hero.scss Hero area CSS
_chat.scss Chat page CSS
_settings.scss Settings CSS
_catagory.scss Catagories CSS
_flash-sale.scss Flash sale CSS
_product.scss All product CSS
_horizontal-product.scss Horizontal product CSS
_featured-product.scss Featured product CSS
_product-details.scss Product details CSS
_cart.scss Cart CSS
_order.scss Order status CSS
_accordion.scss Accordion CSS
_faq.scss FAQ CSS
_blog.scss Blog CSS
_contact.scss Contact CSS
_cta.scss CTA CSS
_profile.scss Profile CSS
_notification.scss Notification CSS
_vendor.scss Vendor pages CSS
_dark.scss dark mode Dark mode CSS

PUG files

With Pug you can easily write HTML code. You have many powerful features at Pug. It's has powerful features like conditions, loops, includes, mixins. When you write HTML code in Pug, it is processed by the template engine into standard HTML code. So that web browsers can understand the code.

Visit the official website to learn the details.
PUG Files Layout
File Description
inc/collection.pug Collection carousel code
inc/coupon.pug Coupon code
inc/cta.pug Call to action code
inc/featured-product.pug Featured product code
inc/filter.pug Filter sidenav code
inc/footer.pug Footer all plugins
inc/footer-nav.pug Footer navigation code
inc/footer-no-internet.pug No internet page footer code
inc/footer-otp.pug OTP page footer code
inc/head.pug Head code
inc/header.pug Header code
inc/hero.pug Hero carousel code
inc/loader.pug Pre-loader code
inc/sidenav.pug Sidenav code
inc/video-cta.pug Video Call to action code
inc/weekly-product.pug Weekly product code
*.pug All HTML Pages All pages code

How to edit the Title & Favicon?

Open the mail file (suha) in your code editor. Then open head.pug file & customize as your desire.

File location: suha > src > pug > inc > head.pug

Customize with Complied Files

Open any *.html file & customize as your desire.

File location: suha > dist > *.html

Remember: The page you will edit, the change will be only that page. So, you need to edit all the HTML files.

How to edit the Brand Logo?

Open the mail file (suha) in your code editor. Then open header.pug file & customize as your desire.

File location: suha > src > pug > inc > header.pug

Customize with Complied Files

Open any *.html file & customize as your desire.

File location: suha > dist > *.html

Remember: The page you will edit, the change will be only that page. So, you need to edit all the HTML files.

How to edit the Side Navbar?

Open the mail file (suha) in your code editor. Then open sidenav.pug file & customize as your desire.

File location: suha > src > pug > inc > sidenav.pug

Customize with Complied Files

Open any *.html file & customize as your desire.

File location: suha > dist > *.html

Remember: The page you will edit, the change will be only that page. So, you need to edit all the HTML files.

How to edit the Footer Nav?

Open the mail file (suha) in your code editor. Then open footer-nav.pug file & customize as your desire.

File location: suha > src > pug > inc > footer-nav.pug

Customize with Complied Files

Open any *.html file & customize as your desire.

File location: suha > dist > *.html

Remember: The page you will edit, the change will be only that page. So, you need to edit all the HTML files.

How to edit the template Colors?

Open the mail file (suha) in your code editor. Then open _variables.scss file & customize as your desire.

File location: suha > src > scss > _variables.scss

Customize with Complied Files

Open style.css file & customize as your desire.

File location: suha > dist > style.css

Progressive Web Apps (PWA)

A progressive web application (PWA) is a type of application software delivered through the web, built using common web technologies including HTML, CSS and JavaScript. It is intended to work on any platform that uses a standards-compliant browser, including both desktop and mobile devices.

Remember: PWA will work if you have a server that serves HTPPS.
Change the Name, Start URL, Theme Color, Catagories, Description & Icons:

Open manifest.json file & customize as your desire.

File location: suha > static > manifest.json

Customize with Complied Files

Open manifest.json file & customize as your desire.

File location: suha > dist > manifest.json

Dark Mode

Dark mode are becoming very popular nowadays. So we have given dark mode in this template. If you want, you can use it as toggle switch mode or by default. Or, you can delete this.

If you want to use it in default mode, use the following code in the <html> tag.

data-theme="dark"

If not, delete the Dark code and toggle switch code from the template.

suha > src > scss > _dark.scss

Customize with Complied Files

Working with compiled files is very easy. You don't need any build tools or local setup to edit the template. A folder (suha/dist) is already provided with the template. Open this folder and edit it as your desired.

Recompiling will overwrite your all changes!

When you will customize with compile files, please do not run the template build tools. If you run the template build tools again, all your changes will be overwritten.

Third Party Plugins Activation

Name Plugins Activation Code
Preloader Active Code
var suhaWindow = $(window);

suhaWindow.on('load', function () {
    $('#preloader').fadeOut('1000', function () {
        $(this).remove();
    });
});
Magnific Popup
(jquery.magnific-popup.min.js)
<!-- Image Gallery Activation -->
$('your_selector_name').magnificPopup({
    type: 'image',
    gallery: {
        enabled: true
    }
});

<!-- Video Popup Activation -->
$('your_selector_name').magnificPopup({
    type: 'iframe'
});
Countdown
(jquery.countdown.min.js)
$('your_selector_name').countdown('YYYY/MM/DD', function (event) {
    var $this = $(this).html(event.strftime(
        '%D Days ' +
        '%H Hour ' +
        '%M Min ' +
        '%S Sec'));
});
Counter Up
(jquery.counterup.min.js)
$('your_selector_name').counterUp({
    delay: 100,
    time: 3000
});
Password Strength
(jquery.passwordstrength.js)
$('your_selector_name').passwordStrength({
    minimumChars: 8
});

Changelog(s)

Version 3.0.1 - October 9, 2022
  • Updated: Bootstrap v5.2.0 > Bootstrap v5.2.2
  • Fixed: Some Minor Bugs
Version 3.0 - Jun 9, 2022
  • New Added: RTL Mode
  • Updated: Bootstrap v5.1.3 > Bootstrap v5.2.0
  • Updated: Design Quality
  • Updated: Documentation 1.1 > Documentation 1.2
  • Updated: Third Party Scripts
  • Fixed: Some Minor Bugs
Version 2.5.0 - July 31, 2021
  • New Added: Three(3) New Vendor Page
  • New Added: 'Static' Folder Under the Main Folder. This Folder Contains All Static Content (Like - CSS/JS/Images/Fonts)
  • Updated: Design Quality
  • Updated: Bootstrap v5.0.0-beta2 > Bootstrap v5.0.2
  • Updated: Owl Carousel 2.2.1 > Owl Carousel 2.3.4
  • Updated: Documentation 1 > Documentation 1.1
Version 2.4.0 - March 22, 2021
  • Updated: Bootstrap v5.0.0-beta1 > Bootstrap v5.0.0-beta2
  • Fixed: Some Minor Issues
Version 2.3.0
  • Updated: Design Quality (Chat Page)
  • Fixed: Some Minor Issues
Version: 2.2.0
  • Updated: Bootstrap v5.0.0-alpha1 > Bootstrap v5.0.0-beta1
  • Updated: Design Quality
Version: 2.1.0
  • New Added: CSS Autoprefixer in npm (Now no need to use SCSS mixins for CSS prefixes)
  • Fixed: Some Minor Bugs
Version: 2.0.0
  • Updated: Bootstrap 4.5.0 > Bootstrap 5.0.0-alpha1
  • Updated: Design Quality
  • New Added: Progressive Web App (PWA)
  • New Added: Dropdown Menu in the Sidebar Area
Version: 1.6.0
  • Fixed: Some Minor Bugs
Version: 1.5.0
  • New Added: About Us Page
  • New Added: Contact Page
  • New Added: OTP Page
  • New Added: OTP Confirmation Page
  • New Added: Featured Product Page
  • Updated: Bootstrap 4.4.1 > Bootstrap 4.5.0
  • Updated: Gulp 3.9.1 > Gulp 4
  • Updated: LineIcons 1.0 > LineIcons 2.0
  • Updated: Design Quality
  • Fixed: Some Minor Issues
Version: 1.4.0
  • Updated: Responsive Quality (Smartphone - Tablet - Laptop - Desktop)
Version: 1.3.0
  • Updated: jQuery Code Quality
Version: 1.2.0
  • New Added: Blog & Blog Details Pages
Version: 1.1.1
  • Updated: Dark Mode
  • Updated: Design Quality
Version: 1.1.0
  • New Added: Dark Mode Version
Version: 1.0.3
  • New Added: LineIcons Web Icons Font
  • Updated: Design Quality
  • Removed: IcoFont Web Icons Font
Version: 1.0.2
  • Updated: Bootstrap 4.3.1 > Bootstrap 4.4.1
  • Updated: Design Quality
Version: 1.0.1
  • Fixed: Some Minor Issues
Version 1.0.0
  • Initial Realease