Amanda Documentation v2.0

Thank you so much for purchasing our theme. If you have any questions that are beyond the scope of this help file, please feel free to email us at themepixels@gmail.com or submit a comment here. Thanks so much!

Introduction

Amanda, a Bootstrap 4 dashboard template using flat and minimal design. It is fully responsive built using SASS preprocessor, HTML5, CSS3 and jQuery plugins. It uses most of the helper/utilities classes which are reusable class that makes the page faster and increases the speed of page time load. It can be used for most type of dashboard and app templates like analytics, admin or messenger app for your desktpo or mobile applications. Amazing flexibility and reusability. See the demo.

Getting Started

This part of the doc will help you to quick start your project and will give you a basic idea about how amanda work. For you to get start open the "themes" folder in templates/ of your download package.

What's In The Box

Once you have download the package you will see the following folder structure inside templates/ folder.

The Tool

Once you have download the package you will see files that you might not familiar along with the folders listed above.

Note: If you are still unsure of what's the use of this files, you may want to proceed to the next topic:

• NodeJS
• Bower
• Grunt

NodeJS

Before installing bower and grunt first you must have NodeJs installed, NodeJS will have npm (node packaged modules).

Node.js is a JavaScript runtime built on Chrome's V8 JavaScript engine. Node.js uses an event-driven, non-blocking I/O model that makes it lightweight and efficient. Node.js' package ecosystem, npm, is the largest ecosystem of open source libraries in the world.

Installing in Mac

Simply download the Macintosh Installer direct from the nodejs.org web site.

If you want to download the package with bash:

curl "https://nodejs.org/dist/latest/node-${VERSION:-$(wget -qO- https://nodejs.org/dist/latest/ | sed -nE 's|.*>node-(.*)\.pkg.*|\1|p')}.pkg" > "$HOME/Downloads/node-latest.pkg" && sudo installer -store -pkg "$HOME/Downloads/node-latest.pkg" -target "/"

Using Homebrew:

brew install node

Installing in Windows

Simply download the Windows Installer direct from the nodejs.org web site.

Bower

Before installing bower first you must have NodeJs installed, NodeJS will have npm (node packaged modules). Once you finished installing nodejs you can now install bower through npm command.

Keeping track of all these packages and making sure they are up to date (or set to the specific versions you need) is tricky. Bower to the rescue!

Bower can manage components that contain HTML, CSS, JavaScript, fonts or even image files. Bower doesn’t concatenate or minify code or do anything else - it just installs the right versions of the packages you need and their dependencies.

Installing Bower

Bower is a command line utility. Install it with npm.

$ npm install -g bower

Verify that bower in successfully installed, and version of installed bower will appear.

$ bower --version

Grunt JS

Before installing grunt first you must have NodeJs installed, NodeJS will have npm (node packaged modules).

In one word: automation. The less work you have to do when performing repetitive tasks like minification, compilation, unit testing, linting, etc, the easier your job becomes. After you've configured it through a Gruntfile, a task runner can do most of that mundane work for you—and your team—with basically zero effort.

Installing the CLI

In order to get started, you'll want to install Grunt's command line interface (CLI) globally. You may need to use sudo (for OSX, *nix, BSD etc) or run your command shell as Administrator (for Windows) to do this.

$ npm install -g grunt-cli

Verify that grunt is successfully installed, and version of installed bower will appear.

$ grunt --version

SASS

Before running grunt first you must check if you have sass installed in your machine. You can verify that sass is already installed by running the command.

$ sass --version

If version appear, it means sass already installed in your machine and proceed to the next topic, otherwise follow the instructions below on installing sass.

Installing SASS

Windows

Before you start using Sass you will need to install Ruby. The fastest way to get Ruby on your Windows computer is to use Ruby Installer. It's a single-click installer that will get everything set up for you super fast.

Mac

If you prefer the command line over an application then getting Sass set up is a fairly quick process. Sass has a Ruby dependency but if you're using a Mac, congratulations, Ruby comes pre-installed.

Install SASS

Ruby uses Gems to manage its various packages of code like Sass. In your open terminal or cmd window:

$ gem install sass

You should now have Sass installed, but it never hurts to double-check.

$ sass --version

Running Amanda

You're moments away to see the amanda dashboard template up and running in your local machine. First, go to the root folder where the bower.json and package.json located. In your download package it should be in the template/ folder. Please run the following command below.

$ bower install

This will download all dependencies defined in bower.json file. Once it finished running the command, it will generate a folder name bower_components/ where you see downloaded files.Next, run another command below

$ npm install

This will download all tools defined in package.json file. Once it finished running the command, it will generate a folder name node_modules/ where you see downloaded tools.Next, run another command below.

$ grunt build

This will compile sass file into css with minified version of it into the css/ folder. On the other hand, it will generate a lib/ folder to extract all needed third party plugins and other resources like fonts to be use in the template.

Running in Browser

Now you're good to go in running the template and preview it in browser by running the command below.

$ grunt

The template is now up and running in your browser. Feel free to visit each page and familiarize the flow of it.

Stylesheet

We use SASS in creating styles in this template logically grouping into sections. Below are the structure of sass files and folders

Bootstrap

All of the files organized into a name of element are override styles of Bootstrap core framework styles. It is overriden for performance and design quality improvement purposes.

To learn more about Bootstrap, visit their site at https://getbootstrap.com/

Plugins

All files organized into a name of plugin are override styles from some of the plugins used in this template and can be found in lib/ folder. It is also overriden for performance and design quality improvement purposes.

Utilities

Utilities classes are very reusable classes with a single purpose to reduce the frequency of highly repetitive declarations.

Note: Below are some of the classes that we think are more reusable. If you did not find any classes on the list be sure to check the scss files under scss/utilities/ folder if there are any existing classes you need before you can create a new style.

Background Color

Borders

Height

Width

Margins

Padding

Position

Typography

If you have any questions that are beyond the scope of this class reference, please feel free to email us at themepixels@gmail.com. Thanks so much!

HTML Structure

Header Panel

<div class="am-header">
  <div class="am-header-left">
    <a id="naviconLeft" href="" class="am-navicon d-none d-lg-flex"><i class="icon ion-navicon-round"></i></a>
    <a id="naviconLeftMobile" href="" class="am-navicon d-lg-none"><i class="icon ion-navicon-round"></i></a>
    <a href="index.html" class="am-logo">amanda</a>
  </div><!-- am-header-left -->

  <div class="am-header-right">
    <div class="dropdown dropdown-notification">
      <a href="" class="nav-link pd-x-7 pos-relative" data-toggle="dropdown">
        <i class="icon ion-ios-bell-outline tx-24"></i>
        <!-- start: if statement -->
        <span class="square-8 bg-danger pos-absolute t-15 r-0 rounded-circle"></span>
        <!-- end: if statement -->
      </a>
      <div class="dropdown-menu wd-300 pd-0-force">
        <div class="dropdown-menu-header">
          <label>Notifications</label>
          <a href="">Mark All as Read</a>
        </div><!-- d-flex -->

        <div class="media-list">
          <!-- loop starts here -->
          <a href="" class="media-list-link read">
            <div class="media pd-x-20 pd-y-15">
              <img src="../img/img8.jpg" class="wd-40 rounded-circle" alt="">
              <div class="media-body">
                <p class="tx-13 mg-b-0"><strong class="tx-medium">Suzzeth Bungaos</strong> tagged you and 18 others in a post.</p>
                <span class="tx-12">October 03, 2017 8:45am</span>
              </div>
            </div><!-- media -->
          </a>
          <!-- loop ends here -->
          <a href="" class="media-list-link read">
            <div class="media pd-x-20 pd-y-15">
              <img src="../img/img9.jpg" class="wd-40 rounded-circle" alt="">
              <div class="media-body">
                <p class="tx-13 mg-b-0"><strong class="tx-medium">Mellisa Brown</strong> appreciated your work <strong class="tx-medium">The Social Network</strong></p>
                <span class="tx-12">October 02, 2017 12:44am</span>
              </div>
            </div><!-- media -->
          </a>
          <a href="" class="media-list-link read">
            <div class="media pd-x-20 pd-y-15">
              <img src="../img/img10.jpg" class="wd-40 rounded-circle" alt="">
              <div class="media-body">
                <p class="tx-13 mg-b-0">20+ new items added are for sale in your <strong class="tx-medium">Sale Group</strong></p>
                <span class="tx-12">October 01, 2017 10:20pm</span>
              </div>
            </div><!-- media -->
          </a>
          <a href="" class="media-list-link read">
            <div class="media pd-x-20 pd-y-15">
              <img src="../img/img5.jpg" class="wd-40 rounded-circle" alt="">
              <div class="media-body">
                <p class="tx-13 mg-b-0"><strong class="tx-medium">Julius Erving</strong> wants to connect with you on your conversation with <strong class="tx-medium">Ronnie Mara</strong></p>
                <span class="tx-12">October 01, 2017 6:08pm</span>
              </div>
            </div><!-- media -->
          </a>
          <div class="media-list-footer">
            <a href="" class="tx-12"><i class="fa fa-angle-down mg-r-5"></i> Show All Notifications</a>
          </div>
        </div><!-- media-list -->
      </div><!-- dropdown-menu -->
    </div><!-- dropdown -->
    <div class="dropdown dropdown-profile">
      <a href="" class="nav-link nav-link-profile" data-toggle="dropdown">
        <img src="../img/img3.jpg" class="wd-32 rounded-circle" alt="">
        <span class="logged-name"><span class="hidden-xs-down">Jane Doe</span> <i class="fa fa-angle-down mg-l-3"></i></span>
      </a>
      <div class="dropdown-menu wd-200">
        <ul class="list-unstyled user-profile-nav">
          <li><a href=""><i class="icon ion-ios-person-outline"></i> Edit Profile</a></li>
          <li><a href=""><i class="icon ion-ios-gear-outline"></i> Settings</a></li>
          <li><a href=""><i class="icon ion-ios-download-outline"></i> Downloads</a></li>
          <li><a href=""><i class="icon ion-ios-star-outline"></i> Favorites</a></li>
          <li><a href=""><i class="icon ion-ios-folder-outline"></i> Collections</a></li>
          <li><a href=""><i class="icon ion-power"></i> Sign Out</a></li>
        </ul>
      </div><!-- dropdown-menu -->
    </div><!-- dropdown -->
  </div><!-- am-header-right -->
</div><!-- am-header -->

Left Sidebar

Below is the html structure of the left sidebar of Amanda admin template that includes menu and icon menu. Some of the class found in left sidebar are explained below.

<div class="am-sideleft">
  <ul class="nav am-sideleft-tab">
    <li class="nav-item">
      <a href="#mainMenu" class="nav-link active"><i class="icon ion-ios-home-outline tx-24"></i></a>
    </li>
    <li class="nav-item">
      <a href="#emailMenu" class="nav-link"><i class="icon ion-ios-email-outline tx-24"></i></a>
    </li>
    <li class="nav-item">
      <a href="#chatMenu" class="nav-link"><i class="icon ion-ios-chatboxes-outline tx-24"></i></a>
    </li>
    <li class="nav-item">
      <a href="#settingMenu" class="nav-link"><i class="icon ion-ios-gear-outline tx-24"></i></a>
    </li>
  </ul>

  <div class="tab-content">
    <div id="mainMenu" class="tab-pane active">
      ...
    </div><!-- #mainMenu -->
    <div id="emailMenu" class="tab-pane">
      ...
    </div><!-- #emailMenu -->
    <div id="chatMenu" class="tab-pane">
      ...
    </div><!-- #chatMenu -->
    <div id="settingMenu" class="tab-pane">
      ...
    </div><!-- #settingMenu -->
  </div><!-- tab-content -->
</div><!-- am-sideleft -->

Main Panel

Below is the html structure of the main panel of Amanda admin template that wraps the contents of the page.

<div class="am-pagetitle">
  <h5 class="am-title">Blank Page</h5>
  <form id="searchBar" class="search-bar" action="index.html">
    <div class="form-control-wrapper">
      <input type="search" class="form-control bd-0" placeholder="Search...">
    </div><!-- form-control-wrapper -->
    <button id="searchBtn" class="btn btn-orange"><i class="fa fa-search"></i></button>
  </form><!-- search-bar -->
</div><!-- am-pagetitle -->

<div class="am-mainpanel">
  <div class="am-pagebody">

    <!-- your content goes here -->

  </div><!-- am-pagebody -->
</div><!-- am-mainpanel -->

Elements

The HTML Markup of alerts, buttons, etc. are explained in the live preview of this template. Feel free to use it in your page. Any components that are beyond of this template, may submit a request and suggestion to our email at themepixels@gmail.com

Javascipt

Showing of Sub Menu

The sub menu are hidden by default and can only be shown when its parent menu is active or clicked. If the parent menu is active during page load, its sub menu will also displayed.

// Show/hide sub navigation of sidebar menu
$('.with-sub').on('click', function(e){
  e.preventDefault();
  $(this).next().slideToggle();
  $(this).toggleClass('show-sub');
});

Show Left Sidebar

The left sidebar is hidden when using smaller screen devices and shows up only when user click on the left navicon of the header. When clicked, the content will be pushed to the right along with the left sidebar that slides from the left to the right.

// Toggles a class that will show/hide left menu
$('#naviconLeft').on('click', function(e) {
  e.preventDefault();
  $('body').toggleClass('collapse-menu');
});

// Toggles a class that will shows/left menu
// and push the mainpanel (mobile only)
$('#naviconLeftMobile').on('click', function(e) {
  e.preventDefault();
  $('body').toggleClass('show-left');
});

Known Issue

• Not displaying font icons in opening the html files directly in a browser.

  A page loaded from a file:// URI, only files in (or below) the same directory of the filesystem are considered to be "same origin", and so putting the font in a different subtree (../font/) means it will be blocked by security policy restrictions. Most browser disables cross-domain fonts "by default. By fixing this, you need to put the file in a remote or local server. Anyway, that what where we're going.

Changelog

v2.0

• Updated based from Bootstrap 4
• Everything New

v1.9 - 1.0

• Deprecated

References

Customer Support

You can request for support via email or themeforest item comments here

We will assist you any problem you encounter while buidling your dashboard via Amanda template

Email: themepixels@gmail.com

We use request help form in comments and email to manage customer support. Soon, as we grow, we will invest and find the best customer support system we can use to serve you better. For the meantime, submit a help request to the link given for any issues and concerns that you have. Don't worry, we will respond to you as quickly as we can. Thank you.