Document
Introduction
Hey !! This is a document for our template POSTMAN:THE CHAT APP. We appreciate your interest in our template and Thank you !! for purchase. We have designed and built an Awesome UI:UX chat app which will make your customer chat even more with simplicity. Lets me share in more details.:
We have built on bootstrap so it will be easy to use if you are familiar with it. And if not then also our document will make it simple for you. We have incorporated an easy to use built in tool and document with all required details included.
Since this theme is based on Bootstrap, and includes nearly everything Bootstrap itself does, you’ll want to give the official project documentation a once over before continuing. There’s also the kitchen sink—a one-page view of all Bootstrap’s components restyled by this theme.
For everything else, including compiling and using this Bootstrap theme, read through the docs below.
Thanks, and enjoy!
What’s included
Below you will find all the file and required documentation of our Postman Chat Theme. We have included all directories and files, common resources and compiled and minified files as some raw file which will be required for your future use.
-
PostMan /
-
dist /
-
assets /
- css /
- images /
- vendor /
- index.html
-
assets /
-
doc /
- index.html
- fonts /
-
js /
- calendar.js
- index.js
- template.js
-
scss /
- base /
- bootstrap /
- font /
- mixins /
- plugin /
- style.scss
- Gruntfile.js
- .gitignore
- package.json
- package-lock.json
- README.md
-
dist /
File Reference | |
---|---|
doc/index.html | Online documentation |
index.html | Landing page |
_variables.scss | All variables |
_core.scss | Create scss variables color code |
Gruntfile.js | Compile scss to css and create js bundles |
Getting started
At the top level of your bootstrap theme you’ll find a directory for each major Bootstrap version that’s supported (currently both v3 and v4). Within each directory you have all the relevant files for that version.
To view your Bootstrap Theme documentation, simply find the docs directory and open index.html in your favorite browser.
$ open index.html
Gulpfiles.js
If you’re after more customization we’ve also included a custom Gulp file, which can be used to quickly re-compile a theme’s CSS and JS. You’ll need to install both Node and Gulp before using our included “gulpfile.js”.
Once node is installed, run the following npm command to install Gulp.
- $ npm install gulp -g or
- To install Glup into your project devDependencies.
- $ npm install --save-dev gulp
- When you’re done, make sure you’ve installed the rest of the theme’s dependencies:
- $ npm install
Gulp Sass: Run Gulp sass command from your project directory. It will compile SASS to CSS for the project. This will read the file `scss/style.scss` and output a plain-css file to `/assets/css/filename.css`.
Now, modify your source files and run “gulp” to generate new local “dist/” files automatically. Be aware that this replaces existing “dist/” files, so proceed with caution.
Gruntfile.js
If you’re after more customization we’ve also included a custom Grunt file, which can be used to quickly re-compile a theme’s CSS and JS. You’ll need to install both Node and Grunt before using our included “gruntfile.js”.
Once node is installed, run the following npm command to install Grunt.
- $ npm install -g grunt-cli or
- To install Grunt into your project devDependencies.
- $ npm install grunt --save-dev
- When you’re done, make sure you’ve installed the rest of the theme’s dependencies:
- $ npm install
Grunt Sass: Run grunt sass command from your project directory. It will compile SASS to CSS for the project. This will read the file `scss/style.scss` and output a plain-css file to `/assets/css/filename.css`.
Now, modify your source files and run “gulp” to generate new local “dist/” files automatically. Be aware that this replaces existing “dist/” files, so proceed with caution.
Theme source code
The “scss/”, “js/”, and “fonts/” directories contain the source code for our CSS, JS, and icon fonts (respectively). Within the “scss/” and “js/” directories you’ll find two subdirectories:
- bootstrap/”, which contains the most recently released version of Bootstrap (v4.0.0).
- “dist/” folder includes everything above, built into single CSS and JS files that can easily be integrated into your project.
The “docs/” folder includes the source code for our documentation, as well as a handful of live examples.
The remaining files not specifically mentioned above provide support for packages, license information, and development.
Gulp/Grunt Files
Leverage the included source files and “gulpfile.js” or “gruntfile.js” to customize your Bootstrap Theme for your exact needs. Change variables, exclude components, and more.
- “scss/base/” folder has custom files, Edit it to build your own custom build, simply modify your local custom files or edit the includes listed here. Note: some themes also rely on a shared style.scss file, which you can find imported.
- “variables.scss” is home to your theme’s variables. Note that your theme’s variables file depends on and overrides an existing Bootstrap variable file (found in /scss/base/_variables.scss).
Main Content
Project Components
Buttons
Use Bootstrap’s custom button styles for actions in forms, dialogs, and more with support for multiple sizes, states, and more.
Social Button
Calendar
<!-- calendar Plugin css file -->
<link rel="stylesheet" href="assets/vendor/bootstrap-datepicker/css/bootstrap-datepicker.min.css">
<div class="body mt-4">
<div id="mini-calendar"></div>
</div>
<!-- calendar Plugin js file -->
<script src="assets/vendor/bootstrap-datepicker/js/bootstrap-datepicker.min.js"></script>
<!-- calendar page js file -->
<script>
// mini calendar js
$('#mini-calendar').datepicker({
todayHighlight: true,
beforeShowDay: function(date){
if (date.getMonth() == (new Date()).getMonth())
switch (date.getDate()){
case 4:
return {
tooltip: 'Example tooltip',
classes: 'active'
};
case 8:
return false;
case 12:
return "green";
}
}
});
</script>
My Notes
- It is a long established fact that a reader will be distracted by the readable content of a page when looking at its layout.
<ul class="list-unstyled">
<li class="card border-0 mb-2">
<span>It is a long established fact that a reader will be distracted by the readable content of a page when looking at its layout.</span>
<button class="btn btn-sm btn-link"><i class="zmdi zmdi-delete text-danger"></i></button>
</li>
</ul>
My Notes
<ul class="list-unstyled todo-list-items">
<li>
<label class="c_checkbox">
<input type="checkbox">
<span class="checkmark"></span>
<span class="ms-2">Update new code on github</span>
</label>
<button class="btn btn-sm btn-link" type="submit"><i class="zmdi zmdi-delete"></i></button>
</li>
<li>
<label class="c_checkbox">
<input type="checkbox">
<span class="checkmark"></span>
<span class="ms-2">Meeting with design team and updates</span>
</label>
<button class="btn btn-sm btn-link" type="submit"><i class="zmdi zmdi-delete"></i></button>
</li>
<li>
<label class="c_checkbox">
<input type="checkbox">
<span class="checkmark"></span>
<span class="ms-2">Send project zip file to developer</span>
</label>
<button class="btn btn-sm btn-link" type="submit"><i class="zmdi zmdi-delete"></i></button>
</li>
<li>
<label class="c_checkbox">
<input type="checkbox">
<span class="checkmark"></span>
<span class="ms-2">Create new design psd for onepage</span>
</label>
<button class="btn btn-sm btn-link" type="submit"><i class="zmdi zmdi-delete"></i></button>
</li>
</ul>
User Card
<div class="card border-0 text-center pt-3 mb-4">
<div class="card-body">
<div class="card-user-avatar">
<img src="assets/images/user.png" alt="avatar">
<button type="button" class="btn btn-secondary btn-sm"><i class="zmdi zmdi-edit"></i></button>
</div>
<div class="card-user-detail mt-4">
<h4>Michelle Green</h4>
<span class="text-muted">[email protected]</span>
<p>+14 123 456 789 - New york (USA)</p>
<div class="social">
<a class="icon p-2" href="#" data-toggle="tooltip" title="" data-original-title="Facebook"><i class="zmdi zmdi-facebook-box"></i></a>
<a class="icon p-2" href="#" data-toggle="tooltip" title="" data-original-title="Github"><i class="zmdi zmdi-github-box"></i></a>
<a class="icon p-2" href="#" data-toggle="tooltip" title="" data-original-title="Linkedin"><i class="zmdi zmdi-linkedin-box"></i></a>
<a class="icon p-2" href="#" data-toggle="tooltip" title="" data-original-title="Instagram"><i class="zmdi zmdi-instagram"></i></a>
</div>
</div>
</div>
</div>
Sign in
<div class="authentication">
<div class="container d-flex flex-column">
<div class="row align-items-center justify-content-center no-gutters min-vh-100">
<div class="col-12 col-md-7 col-lg-5 col-xl-4 py-8 py-md-11">
<div class="card border-0 shadow-sm">
<div class="card-body">
<!-- Heading -->
<h3 class="text-center">Sign in</h3>
<!-- Text -->
<p class="text-center mb-6">Make it simple, but significant</p>
<!-- Form -->
<form class="mb-4 mt-5">
<!-- Email -->
<div class="input-group mb-2">
<input type="email" class="form-control form-control-lg border-end-0" placeholder="Enter your email">
<div class="input-group-append">
<span class="input-group-text border-start-0"><i class="zmdi zmdi-email"></i></span>
</div>
</div>
<!-- Password -->
<div class="input-group mb-4">
<input type="password" class="form-control form-control-lg border-end-0" placeholder="Enter your password">
<div class="input-group-append">
<span class="input-group-text border-start-0"><i class="zmdi zmdi-lock"></i></span>
</div>
</div>
<div class="form-group d-flex justify-content-between">
<label class="c_checkbox">
<input type="checkbox">
<span class="ms-2 todo_name">Remember me</span>
<span class="checkmark"></span>
</label>
<a class="link" href="password-reset.html">Reset password</a>
</div>
<!-- Submit -->
<div class="text-center mt-5">
<a href="index.html" class="btn btn-lg btn-primary" title="">Sign in</a>
</div>
</form>
<!-- Text -->
<p class="text-center mb-0">Don't have an account yet <a class="link" href="signup.html">Sign up</a>.</p>
</div>
</div>
</div>
<div class="signin-img d-none d-lg-block">
<img src="assets/images/signin-img-cyan.svg" alt="Sign In Image">
</div>
</div> <!-- / .row -->
</div>
</div>
Chat Body
<ul class="list-unstyled py-4">
<!-- Message: Left -->
<li class="d-flex message">
<!-- Avatar -->
<div class="mr-lg-3 me-2">
<img class="avatar sm rounded-circle" src="../dist/assets/images/xs/avatar5.jpg" alt="avatar">
</div>
<!-- End Avatar -->
<div class="message-body">
<span class="date-time text-muted">Jason, 7:19 PM</span>
<div class="message-row d-flex align-items-center">
<!-- Message: content -->
<div class="message-content p-3">
Hello, <br> How are you?
</div>
<!-- Message: dropdown -->
<div class="dropdown">
<a class="text-muted ms-1 p-2 text-muted" href="#" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
<i class="zmdi zmdi-more-vert"></i>
</a>
<div class="dropdown-menu dropdown-menu-right">
<a class="dropdown-item" href="#">Edit</a>
<a class="dropdown-item" href="#">Share</a>
<a class="dropdown-item" href="#">Delete</a>
</div>
</div>
<!-- End Message: dropdown -->
</div>
</div>
</li>
<!-- Message: Divider -->
<li class="d-flex message divider mt-xl-5 mt-md-3 mb-xl-5 mb-md-3">
<small class="text-muted">Sunday</small>
</li>
<!-- End message divider -->
<!-- Message: Right-->
<li class="d-flex message right">
<div class="message-body">
<span class="date-time text-muted">7:19 PM <i class="zmdi zmdi-check-all text-primary"></i></span>
<div class="message-row d-flex align-items-center justify-content-end">
<!-- Message: dropdown -->
<div class="dropdown">
<a class="text-muted me-1 p-2 text-muted" href="#" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
<i class="zmdi zmdi-more-vert"></i>
</a>
<div class="dropdown-menu">
<a class="dropdown-item" href="#">Edit</a>
<a class="dropdown-item" href="#">Share</a>
<a class="dropdown-item" href="#">Delete</a>
</div>
</div>
<!-- End Message: dropdown -->
<!-- Message: content -->
<div class="message-content border p-3">
It is a long established fact that a reader will be distracted by the readable content of a page when looking at its layout.
</div>
</div>
</div>
</li>
<!-- Message: Left Typing -->
<li class="d-flex message">
<!-- Avatar -->
<div class="mr-lg-3 me-2">
<img class="avatar sm rounded-circle" src="../dist/assets/images/xs/avatar5.jpg" alt="avatar">
</div>
<!-- End Avatar -->
<div class="message-body">
<div class="message-row d-flex align-items-center">
<!-- Message: content -->
<div class="message-content p-3">
<div class="wave">
<span class="dot"></span>
<span class="dot"></span>
<span class="dot"></span>
</div>
</div>
</div>
</div>
</li>
</ul>
Credits
Bootstrap 4x | http://getbootstrap.com/ |
Jquery | https://jquery.com/ |
Gulp | https://gulpjs.com/ |
Grunt | https://gruntjs.com/ |
Node Js | https://nodejs.org/en/download/ |
Google fonts ( Nunito ): | https://fonts.google.com/specimen/Nunito |
Material Icon Font | https://zavoloklom.github.io/material-design-iconic-font/icons.html |
All Images are used | |
Full Calendar | https://fullcalendar.io/ |
Customer Support
You can request for support via email or GetBootstrap item comments.
We will assist you any problem you encounter while building your Chat App via this template
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.
© 2020. POSTMAN : Chat App Documentation v1.0.0. All Rights Reserved.
Created by: PuffinTheme
Change Log
Version 1.0.0 | 07 Sept 2020 | -- Initial Release |