EmailChimp

Template documentation version 1.0


Introduction


First of all, Thank you so much for purchasing this template and for being my loyal customer.

This documentation is to help you regarding each step of customization. Please go through the documentation carefully to understand how this template is made and how to edit this properly. Basic HTML and CSS knowledge is required to customize this template. You may learn basics here, here and here. In gulp version you need to know about gulp, scss and hbs.

Quick Start

Get details about Requirements, Basic Installation, Structure, Color mode, Logo, favicon and loader setup your project with easy steps.

Requirement

This template have required 2 depandency

  1. NodeJS
  2. Gulp

File Structure

Here is the general File structure of the template:

  • Template
    • gulp+hbs
      • src
        • assets
          • css
          • scss
          • js
          • images
          • vendor
        • template
          • app
            • all app html pages
          • backend
            • all backend html pages
      • gulp
        • all gulp task here
      • JsonData
        • all sidebar list item come with json file
      • gulp.config.json
      • gulpfile.js
      • package.json
    • html
      • assets
        • css
        • js
        • images
        • vendor
      • app
        • all app html pages
      • backend
        • all backend html pages
    • documentation
      • asset
      • index.html

Installation

Steps to be follow for getting started with the template:

Gulp

  1. Start command prompt window or terminal and change directory gulp+hbs
    cd gulp+hbs
  2. Install via the npm
    npm install
  3. For development
    npm run dev
    OR
    gulp watch
  4. For build
    npm run build
    OR
    gulp build

HTML

  1. Open prox-html Folder to find all the Templates Files
  2. You'll have to upload these file using a FTP on your server
  3. Make sure you maintain the structure while uploading the required files/folders:
    • HTML/assets/css - Stylesheets Folder
    • HTML/assets/images - Images Folder
    • HTML/assets/js - Javacripts Folder
    • HTML/assets/vendor - Vendor Folder
    • HTML/app -App Folder
    • HTML/backend/index.html - Index File/Homepage
    Other files can be used according to your convenience.
  4. Now that you have followed these steps your basic installation is complete and ready to flaunt your site to the world.

Customization

There are some customization like change color, logo, loader, favicon, default mode (dark or light) etc...

Color

Here is the Change color mode Dark/Light in gulp

Goto gulp.config.json and dark mode change with json file

For Dark mode
                                                    "dark": true
                                                
For Light mode
                                                    "dark": false
                                                

Here is the Change color mode Dark/Light in html

                                                    If you want to light mode
                                                    <body>

                                                    If you want to Dark mode
                                                    <body class="dark">
                                                

Here is the Change color of template in gulp

Go to src/assets/scss/_custom_variable.scss and add some color variable.

                                                    $primary-light: #c9dcff;
                                                    $primary: #4788ff;
                                                    $primary-dark: #1360ee;
                                                

Favicon icon

Favicon is an icon associated with the URL that is displayed at various places, such as in a browser’s address bar or next to the site name in a bookmark list.

You can add a Favicon to your Website using the following code:

In Gulp version favicon change with 2 diffrent way

  1. Replace favicon image or rename favicon icon name. or go to src/template/partials/backend/head.hbs file and change.
  2. Go to gulp.config.json and add or change path set with images so you dont need to add images/favicon.ico faviconName: "{faviconImage}.ico"

Loading Transitions

Page Loading Transitions are enabled by default. If you wish to disable the page loading transition you can simply delete below section

                                                

In gulp version loader change with 2 diffrant way

  • Replace loader image. or go to src/template/partials/backend/loader.hbs file and change.
  • Go to gulp.config.json and add or change path set with images so you dont need to add images/loader.gif loaderName: "{loaderImage}.gif"

For Changing Fonts

You can add/change the site font, from all fonts used from Google Web Font Services, with the one that suits you the best. You can find the font link in top of the Style.css in all HTML file. See example below:

                                                
                                                
                                            

To include new font you can simply add another link like this:

                                                
                                                
                                                
                                            

In order to change the fonts, you will need to edit the above links with your custom font, You can easily use Google Web Font Services if you plan to use a Google Font or remove it completely. If you plan to use a self hosted font, here is an Example of using Self Hosted Fonts

In gulp+hbs version change with scss file.

  1. Go to src/assets/scss/helper/_fonts.scss and change google fonts
                                                            
                                                            
                                                            @import url('https://fonts.googleapis.com/css2?family=DM+Sans:wght@400;500;700&display=swap');
  2. Go to src/assets/scss/_variable.scss and change font family variable
                                                            $font-family-title: 'DM Sans', sans-serif;
                                                            $font-family-base: 'DM Sans', sans-serif;
                                                        

HTML Structure

Here is the general HTML structure of the template:

                                                <!DOCTYPE html>
                                                <html lang="en">
                                                <head>
                                                [Page meta, page css, page js files, page title etc...]
                                                </head>
                                                 <body>
                                                
                                                   <!-- preloader -->
                                                   <div  id="loading" > [LOADER CONTENT] </div>
                                                   <!--preloader -->
                                                
                                                   <!--header -->
                                                   <header>
                                                
                                                 </header>
                                                   <!--header -->
                                                
                                                   <!--main-content- -->
                                                   <div class="main-content">
                                                    <!--Section 1 -->
                                                    <section>
                                                    [SECTION 1 CONTENT]
                                                    </section>
                                                    <!--Section 1 -->
                                                     <!--Section 2 -->
                                                    <section>
                                                    [SECTION 2 CONTENT]
                                                    </section>
                                                    <!--Section 2 -->
                                                    <div>
                                                    <!--main-content -->
                                                   <!--footer -->
                                                   <footer class="iq-footer2">
                                                   [FOOTER_CONTENT]
                                                   </footer>
                                                   <!--footer -->
                                                  [PAGE JAVASCRIPTS HERE]
                                                 </body>
                                                </html>
                                            

CSS Structure

Here is the general CSS structure of the template:

                                                <!-- Backend CSS -->
                                                <link rel="stylesheet" href="../assets/css/backend.min.css">

                                                <!-- fontawesome CSS -->
                                                <link rel="stylesheet" href="../assets/vendor/@fortawesome/fontawesome-free/css/all.min.css">

                                                <!-- line-awesome CSS -->
                                                <link rel="stylesheet" href="../assets/vendor/line-awesome/dist/line-awesome/css/line-awesome.min.css">

                                                <!-- remixicon CSS -->
                                                <link rel="stylesheet" href="../assets/vendor/remixicon/fonts/remixicon.css">

                                                <!-- dripicons CSS -->
                                                <link rel="stylesheet" href="../assets/vendor/@icon/dripicons/dripicons.css">
                                            

Javascript Structure

Here is the general Javascript structure of the template:

                                                <!-- backend-bundle JS -->
                                                <script src="../assets/js/backend-bundle.min.js" ></script>

                                                <!-- ionicons  -->
                                                <script src="../assets/vendor/ionicons/dist/ionicons.js"></script>

                                                <!-- Flextree -->
                                                <script src="../assets/js/flex-tree.min.js" ></script>
                                                <script src="../assets/js/tree.js" ></script>

                                                <!-- Table Treeview JavaScript -->
                                                <script src="../assets/js/table-treeview.js"></script>

                                                <!-- Masonary JavaScript -->
                                                <script src="../assets/js/masonry.pkgd.min.js"></script>
                                                <script src="../assets/js/imagesloaded.pkgd.min.js"></script>

                                                <!-- Mapbox JavaScript -->
                                                <script src="../assets/js/mapbox-gl.js"></script>
                                                <script src="../assets/js/mapbox.js"></script>

                                                <!--SweetAlert JavaScript -->
                                                <script src="../assets/js/sweetalert.js"></script>

                                                <!-- Vectoe Map JavaScript -->
                                                <script src="../assets/js/vector-map-custom.js"></script>

                                                <!--customizer JavaScript -->
                                                <script src="../assets/js/customizer.js"></script>
                                                
                                                <!--Chart Custom JavaScript -->
                                                <script src="../assets/js/chart-custom.js"></script>

                                                <!--slider JavaScript -->
                                                <script src="../assets/js/slider.js"></script>

                                                <!-- app JavaScript  -->
                                                <script src="../assets/js/app.js" ></script>
                                            

Helper classes

For section padding

You can add this helper class to set section padding top 100px and padding bottom 100px.
Add overview-block-ptb class in section tag. See example below:

                                        <section class="... overview-block-ptb">
                                        [YOUR CONTENT]

</section>

Note Use this helper class to maintain all page section spacing. You can also use overview-block-pt for only padding top and overview-block-pb for only padding bottom.

For Text color

You can use color in the Text. simply add .main-color ( or any color you want) class where you want to use. See example below:

                                        <div class="text-primary">
                                        [YOUR TEXT CONTENT]
                                        </div>
                                    

Note We include 4 color helper class in our template text-gray, text-black, main-color and text-white. you can add unlimited color class according to your needs.

For Background color

You can use color in the background. simply add .white-bg (or any color you want) class where you want to use. See example below:

                                        <div class="bg-primary">
                                        [YOUR CONTENT]
                                        </div>
                                    

Note We include 4 color helper class in our template text-gray, text-black, main-color and text-white. you can add unlimited color class according to your needs.

For Background Images and pattern

You can use an image in the background with parallax effect by simply adding InlineStyle in div tag and by use of this you can create your own background. See example below:

                                        <div style="background-image:url(Path); ">
                                        [YOUR CONTENT]
                                        </div>
                                    

If your background is small and you want to use repeated background then use styling property background-repeat and set the value repeat or no-repeat. See the example below:

                                        <div style="background-image:url(Path); background-repeat:no-repeat;">
                                        [YOUR CONTENT]
                                        </div>
                                    

If you want to use your background like cover or cointainer. You just need to add styling property background-size and set the value cover or cointainer. see the example below:

                                        <div style="background-image:url(Path); background-size:cover;">
                                        [YOUR CONTENT]
                                        </div>
                                    

For Background overlay

You can use these .iq-over-black-30, .iq-over-white-20, .iq-over-green-90 classes to any element in your HTML code to apply overlay color on any image or section. See example below:

                                        <div class="iq-over-black-80">
                                        [YOUR CONTENT]
                                        </div>
                                    

Structure: .iq-over-{color}-{opacity}. For Example, .iq-over-black-80

Bootstrap Components

For Sliders

There 2 different sliders for you to be used on any page with variety of Options. List of the Sliders:

Source & Credits

All images and videos are for preview purposes only and are not included in the download files. Images are of copyrights under Creative Commons CC0.

Tool

Images



Scripts



CSS & Fonts