Documentation Bootstrap
Documentation Bootstrap
● Túpac Amaru
Túpac Amaru
AvailableAccountSettingsLogout
●
●
○ Notifications3
■
Jessica Caruso accepted your invitation to join the team.2 min ago
■
Joel King is now following you2 days ago
■
John Doe is watching your main repository2 days ago
■
Emily Carter is now following you5 days ago
View all notifications
●
○ GitHub
Bitbucket
Slack
Dribbble
Mail Chimp
Dropbox
More
Documentation
● Menu
● Dashboard
● UI Elements
○ Alerts
○ Buttons
○ NewCards
○ Panels
○ General
○ Modals
○ Notifications
○ Icons
○ Grid
○ Tabs & Accordions
○ Nestable Lists
○ Typography
○ NewDrag & Drop
○ NewSweetalert 2
● Charts
○ Flot
○ Sparklines
○ Chart.js
○ Morris.js
● Forms
○ Elements
○ Validation
○ Multiselect
○ Wizard
○ Input Masks
○ WYSIWYG Editor
○ Multi Upload
● Tables
○ General
○ Data Tables
○ NewTable Filters
● Pages
○ Blank Page
○ Blank Page Header
○ Login
○ Login v2
○ 404 Page
○ Sign Up
○ Forgot Password
○ Profile
○ Pricing Tables
○ Pricing Tables v2
○ Timeline
○ Timeline v2
○ NewInvoice
○ Calendar
○ Gallery
○ New Code Editor
○ NewBooking
○ NewLoaders
○ NewAJAX Loader
● Features
● Email
○ Inbox
○ Email Detail
○ Email Compose
● Layouts
○ Primary Header
○ Success Header
○ Warning Header
○ Danger Header
○ Search Input
○ Off Canvas Menu
○ NewTop Menu
○ Without Left Sidebar
○ Without Right Sidebar
○ Without Both Sidebars
○ Fixed Left Sidebar
○ NewBoxed Layout
○ Page Aside
○ Collapsible Sidebar
○ NewSub Navigation
○ NewMega Menu
● Maps
○ Google Maps
○ Vector Maps
● Menu Levels
○ Level 1
■ Level 2
■ Level 2
■ Level 3
■ Level 3
○ Level 1
■ Level 2
■ Level 2
■ Level 3
■ Level 3
● Documentation
60%Current Project
Documentation
Beagle docs
● General
○ Introduction
○ HTML Structure
○ JavaScript
● Getting Started
○ Basic Setup
○ Using npm
○ Install dependencies
○ Setup Sass
○ Variables
○ NPM scripts
○ Add new dependencies
● Plugins
● Support
● Changelog
Introduction #
Thank you for support our work, Beagle is an HTML/CSS/JS admin template based on the
famous Bootstrap framework, made it with love in every pixel.
In this document you will find a complete guide which covers topics about the product
functionality, components, structure, workflow and the initial setup.
Folder Structure #
Once you've downloaded this product, extract the zip file and you will find these directories:
beagle.zip
beagle
├── dist
├──── html
├──── starter
├── src
├── dep-copy.json
├── package.json
└── README.md
dist
This folder contains the final production-ready compiled files
html
This folder contains the complete distribution version with all demo content included as seen in
the live preview version.
starter
This folder contains the essentials components, this version does not include any of the live
preview examples. This is especially designed to get started with only the needed elements.
src
In this folder you'll find the template's source code, if you want to customize the template to fit
your specific needs, this is the right place to start with.
dep-copy.json
In this file you'll find the libraries that are copied from "node_modules" to "src/assets/lib". If you
want add a new libraries, this file is necessary.
package.json
This is the npm manifest file in which we define what are going to be our workflow
dependencies and our main tasks.
HTML Structure #
The template main structure is divided in four sections: Top bar, Left sidebar, Right sidebar
and Main content.
Main Structure
<!DOCTYPE html>
<html lang="en">
<body>
<div class="be-wrapper">
<nav class="navbar navbar-expand fixed-top be-top-header">
<!-- Top bar -->
</nav>
<div class="be-left-sidebar">
<!-- Left sidebar -->
</div>
<div class="be-content">
<!-- Main Content -->
</div>
<nav class="be-right-sidebar">
<!-- Right sidebar -->
</nav>
</div>
</body>
</html>
Required Dependencies #
This template require four libraries to work:
● jQuery 1.9.1 (or later)
● Bootstrap 4.1.2
● Perfect Scrollbar 1.4.0
● Material Design Iconic Font (latest)
In addition to these libs, the main structure needs a basic modular js core to provide the
template interaction like sidebars functionality. This file is located in "assets/js/app.js"
There are some dependencies embedded in the app.js file that adds extra functionality to the
template:
● Fast Click 1.0.3
● Tiny Color 1.2.1
● jQuery Touch Swipe 1.6.12
● jQuery Bootstrap 4 Breakpoint Check 1.0.5
Note: You don't need to add these last dependencies because they are already included in the
app.js file
Include the dependencies #
Be sure to include the essentials scripts in your pages, for example inside your head tag should
be like this:
Head Links
And just before the body tag ends, please add these JavaScript libs:
Footer Scripts
<script src="assets/lib/jquery/jquery.min.js" type="text/javascript"></script>
<script type="text/javascript">
$(document).ready(function(){
//initialize the javascript
App.init();
});
</script>
Top bar #
We are extending the Bootstrap Navbar component using the fixed version by default, we also
added some custom elements:
<!-- Left navbar (Used only when there is no left sidebar) -->
<a href="#" data-toggle="collapse" data-target="#be-navbar-collapse" class="be-toggle-top-header-
menu collapsed">No Sidebar Left</a>
<div id="be-navbar-collapse" class="navbar-collapse collapse">
<!-- Default bootstrap navbar -->
</div>
</div>
</nav>
Navbar Header
In this element you'll find the app logo, located in the top left corner ("navbar-brand"), it will be
shown on large devices and hidden on small resolutions:
Main topbar elements
Is composed by a group of elements which one of them is going to be hidden("page-title") on
small devices.
Desktop View
Small View
JavaScript #
In every page, we are calling an object method which handles the basic template interaction. It's
written with "The Module Pattern" which encapsulates certain code, allowing to be used when
it's needed.
We use a global javascript object called "App", it provides a modular structure that we use to
initialize the demo Js plugins on each demo page. You can find several modules in "assets/js"
inside the html folder.
Said that you'll notice that there are different Js modules for some of the demo pages, all of
them are optional, exept the "app.js" or "app.min.js" in case you want to use the minified
version.
Important: Please don't add any custom Js code inside this file because you'll lose it when you
update the template.
init() Method #
This method is responsible for some of the bootstrap plugins initializing, both sidebars
functionality and other responsive tasks. That's why this is the core method of this template.
You can add it at the end of the page like this:
Footer Scripts
<script type="text/javascript">
$(document).ready(function(){
App.init();
});
</script>
Footer Scripts
App.moduleName = function( ){
'use strict'
//Js Code
};
return App;
})(App || {});
Getting Started #
There are three different ways to use this template in your next project:
● Basic Setup
● Using SASS files
● Using NPM scripts
Basic Setup #
This is the quickest way to setup the template, you just have to copy the "starter" folder content
into your project root folder and start working on the index.html file.
Important: Using this method you'll need to add your custom styles in a different css file, to
avoid losing changes when you update the template.
Be sure to include the essentials scripts in your document to get things work properly. After that
you're ready to start building.
Cons
This method is perfect if you think you are not going to make several changes to the original
version and use it "as is", otherwise we suggest to use one of the following methods.
NPM scripts #
The NPM scripts are a property of the package.json file, which allows us to define commands
that will be executed several times in our workflow. We can create commands to execute tasks
or operations like install, compile, minify, remove, distribute, etc., all without having to depend of
a task runner.
If you haven't used NPM scrips before, be sure to check out the npm-scripts documentation.
Supposing that you already are familiar with NPM scrips, we are going to explain step by step
how to get started with the built-in workflow.
Install Node #
If you already have Node.js installed you can skip this step.
1. Be sure to have the latest version of Node.js installed & running in your computer. We are
going to use npm that comes with Node.js installation.
Install npm dependencies #
In your root folder enter the following command to install the project dependencies: npm install,
this command will install all the template libraries inside the source folder: src/assets/libs, you
need to run this command before you run npm run dist in order to include dependencies in
distribution.
Setup SASS development environment #
In case you don't know nothing about css pre-processors, this is a brief description about what it
is:
SASS is the most mature, stable, and powerful professional grade CSS extension language in
the world.
Taken from sass-lang.com
In other words with css-preprocessors you can change the full color theme of this template by
just changing a few lines of code.
Setting up your css file #
1. In the sass folder src/sass/ you'll find a file called app.scss.
2. Rename it to a different name, for example app.scss => beagle.scss.
3. Then create a new file called app.scss which you are going to use it to modify variables
and create your custom code.
4. After that, you'll need to include the original main SASS file into the new file like this:
app.scss
// Overwrite templates variables here
Inside this file you can modify the bootstrap and template variables values for example to
change the color scheme:
app.scss
// Modify template colors
$primary: #595BD4;
$danger: #FD3D39;
$warning: #FFCB2F;
$success: #53D86A;
// Import the template source code
@import "beagle";
Variables #
The template comes with several veriables that you can use to customize and create your own
version, alongside with the Bootstrap default variables.
To see what variables are available go to "src/sass/config/_beagle-variables.scss".
Available Commands #
After install dependencies now you can run the automated scripts:
NPM Scripts
Command Description
npm install Install and copy all the template libraries into
src/assets/lib using the
dep-copy.json file.
npm start It runs the watch command and an express
development server in
http://localhost:8080/index.html, this way you
can modify your SASS files and it automatically
compiles your code.
npm run dist Generate the ready-to-use distribution based on
changes made on src directory, the distribution
files will be located at dist folder.
Adding new dependencies #
You can add new dependencies easily using npm, just open your terminal in your root path and
install the dependency as usual using npm install dependency-name --save, then you'll need to
add a new entry on dep-copy.json file.
We use a dep-copy.json file to filter which files do we really want to be copied to our
development/production environment reducing the unnecessary load of unused files.
Open the dep-copy.json file and add a new entry like this:
dep-copy.json
"npm-package-name": {
"files":{
"npm-dependency-destination/css" : "npm-dependency-name/css/*",
"npm-dependency-destination/js" : "bootstrap/js/*"
}
}
Change
Change
Change
Change
Change
Change
Change
Change
Change
Change
Change
Change
Change
Change
Change
Initial Release
● Chat
● Todo
● Settings
Recent
Mike Bolthort
Maggie jackson
Jhon Voltemar
Maggie jackson
Active 1h ago
● Hello
● Hi, how are you?
● Good, I'll need support with my pc
● Sure, just tell me what is going on with your computer?
● I don't know it just turns off suddenly
Today
● Initialize the project
● Create the main structure
● Updates changes to GitHub
Tomorrow
● Initialize the project
● Create the main structure
● Updates changes to GitHub
● This task is too long to be displayed in a normal space!
General
● Available
● Enable notifications
● Login with Facebook
Notifications
● Email notifications
● Project updates
● New comments
● Chat messages
Workflow
● Deploy on commit