Affan - PWA Mobile HTML Template

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!

Files Structure

• Affan
  • 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)
    • 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.

• Brackets
• Sublime Text
• Visual Studio Code Recommended
• Atom
• Notepad++
• Php Storm

Installation

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.

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.

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

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: affan > "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: affan > "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: affan > "static" folder

Before getting started you must read this

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.

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.

How to edit the Title & Favicon?

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

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

Customize with Complied Files

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

File location: affan > dist > *.html

How to edit the Brand Logo?

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

File location: affan > src > pug > inc > header.pug/header*.pug

Customize with Complied Files

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

File location: affan > dist > *.html

How to edit the Side Navbar?

Open the mail file (affan) in your code editor. Then open sidenav.pug/sidenav-right.pug file & customize as your desire.

File location: affan > src > pug > inc > sidenav.pug/sidenav-right.pug

Customize with Complied Files

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

File location: affan > dist > *.html

How to edit the Footer Nav?

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

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

Customize with Complied Files

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

File location: affan > dist > *.html

How to edit the template Colors?

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

File location: affan > src > scss > _colors.scss

Customize with Complied Files

Open style.css file & customize as your desire.

File location: affan > 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.

Change the Name, Start URL, Theme Color, Catagories, Description & Icons:

Open manifest.json file & customize as your desire.

File location: affan > static > manifest.json

Customize with Complied Files

Open manifest.json file & customize as your desire.

File location: affan > 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.

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

Right to Left (RTL) Mode

The languages of many countries of the world are written in RTL mode. So RTL mode has been given in it. 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.

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

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 (affan/dist) is already provided with the template. Open this folder and edit it as your desired.

Third Party Plugins Activation

var slider = tns({
    container: ".tiny-slider-one", // Slider container name
    items: 1, // The number of slides to be shown at once. 
    slideBy: "page",
    autoplay: true,
    autoplayButtonOutput: false,
    autoplayTimeout: 5000,
    speed: 1000,
    mouseDrag: true,
    controlsText: [(''), ('')],
    responsive: { // Responsive mode
        480: {
            items: 7
        },
        576: {
            items: 7
        },
        768: {
            items: 8
        },
        992: {
            items: 10
        },
        1200: {
            items: 10
        }
    }
});

let magicGrid = new MagicGrid({
    container: '#filterContainer', // Container name
    animate: true,
    gutter: 16, // Space between two items
    static: true,
    useMin: true
});

magicGrid.listen();

window.addEventListener("load", function () {
    baguetteBox.run("your_container_name", {
        captions: false,
        fullScreen: false,
        animation: "slideIn", // Also available 'fadeIn' or 'false' options
        overlayBackgroundColor: "rgba(15,7,15,0.7)"
    });
});

new countdown({
    target: '#countdown1', // Container name
    dayWord: ' Days',
    hourWord: ' Hours',
    minWord: ' Mins',
    secWord: ' Secs'
});

ionRangeSlider(ionRangeSlider1, {options});

var dataTable = new DataTable(your_container_name, {
    perPage: 10,
    perPageSelect: [10, 20, 30, 40, 50],
    searchable: true,
    sortable: true,
    fixedHeight: false,
    prevText: '',
    nextText: '',
    labels: {
        placeholder: "Search",
        perPage: "{select}",
        noRows: "No data!",
        info: "{start} to {end} entries",
    }
});

Credits

• Framework
• Bootstrap
• Fonts & Icons
• Bootstrap Icons
• Google Fonts
• Images
• Unsplash
• Freepik
• Plugins
• Counter Up
• baguettebox
• Magic Grid
• Range Slider
• Countdown
• Password Meter
• Tiny Slider
• Slide Toggle
• Table & Charts
• Data Table
• Apex Charts
• Maps
• Google Maps