Documentation
Table of contents
Introduction
CelestialUI Admin is a responsive HTML template that is based on the CSS framework Bootstrap 4 and it is built with Sass. Sass compiler makes it easier to code and customize. If you are unfamiliar with Bootstrap or Sass, visit their website and read through the documentation. All of Bootstrap components have been modified to fit the style of CelestialUI Admin and provide a consistent look throughout the template.
Before you start working with the template, we suggest you go through the pages that are bundled with the theme. Most of the template example pages contain quick tips on how to create or use a component which can be really helpful when you need to create something on the fly.
Note: We are trying our best to document how to use the template. If you think that something is missing from the documentation, please do not hesitate to tell us about it. If you have any questions or issues regarding this theme, email us at support@bootstrapdash.com
Getting started
You can directly use the compiled and ready-to-use the version of the template. But in case you plan to customize the template extensively the template allows you to do so.
Within the download you'll find the following directories and files, logically grouping common assets and providing both compiled and minified variations:
Note: The root folder denoted further in this documentation refers to the 'template' folder inside the downloaded folder
We have bundled up the vendor files needed for demo purpose into a folder 'vendors', you may not need all those vendors in your application. If you want to make any change in the vendor package files, you need to change the src path for related tasks in the file gulpfile.js and run the task bundleVendors to rebuild the vendor files.
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 in 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 (for the mac users).
This will install the dev dependencies in the local node_modules folder in your root directory.
Then you will need to install Gulp. We use the Gulp task manager for the development processes. Gulp will watch for changes to the SCSS files and automatically compile the files to CSS.
Getting started with Gulp is pretty simple. The Gulp site is a great place to get information on installing Gulp if you need more information. You need to first install Gulp-cli in your machine using the below command.
This installs Gulp-cli globally to your machine. The other thing that Gulp requires, which, is really what does all the work, is the gulpfile.js. In this file, you set up all of your tasks that you will run.
Don't worry. We have this file already created for you!
To run this project in development mode enter the following command below. This will start the file watch by gulp and whenever a file is modified, the SCSS files will be compiled to create the CSS file.
gulp serve command from the directory where the gulpfile.js is located.
Basic structure
The below snippet shows the basic HTML structure of CelestialUI Admin. Please note that all the stylesheets and script files in the below snippet should be included to render CelestialUI Admin styles.
This section contains code of default vertical layout. For other layouts in vertical mode like boxed, icon-menu etc., you can follow the snippet same as below, but you have to just add the appropriate optional class to the body. More details of the classes are given in Options section
Components
Basic UI Elements
Button with the single color
Outlined
Sizes
Bootstrap Accordion
Bootstrap Dropdown
Dropdown Outlined
Bootstrap Tabs
Bootstrap Modal
Bootstrap Pagination
Bootstrap Badges
Tables
To create a basic Twitter Bootstrap table, add the following code.
Charts
Chart.js is a simple yet flexible JavaScript charting for designers & developers.
Usage
To use Chart.js in your application, include the following files in <head>.
and the following script files in <body>.
To create a simple chart, add the following code:
Forms
The basic form elements can be added to your application as below:
Icons
Material Design Icons growing icon collection allows designers and developers targeting various platforms to download icons in the format, color and size they need for any project.
Usage
To use Material Design Icons in your application, include the following files in <head>.
To generate an icon, add the following code:
Credits
We have used the following plugins in CelestialUI Admin
- Ace editor https://ace.c9.io/
- Bootstrap https://getbootstrap.com/
- Bootstrap Datepicker https://gitter.im/uxsolutions/bootstrap-datepicker
- Bootstrap Maxlength http://mimo84.github.com/bootstrap-maxlength
- C3 https://travis-ci.org/c3js/c3
- Chart.js https://www.chartjs.org/
- Chartist https://gionkunz.github.io/chartist-js/
- Clipboard https://clipboardjs.com
- Codemirror https://codemirror.net/
- Colcade https://github.com/desandro/colcade/
- D3 https://d3js.org
- Datatables.net https://datatables.net/
- Dragula https://bevacqua.github.io/dragula/
- Dropify http://jeremyfagis.github.io/dropify/
- Dropzone http://www.dropzonejs.com/
- Flag icons http://lipis.github.io/flag-icon-css/
- Flot https://www.flotcharts.org/
- Font awesome https://fontawesome.com/
- Full calendar https://fullcalendar.io/
- Gulp https://gulpjs.com/
- Icheck http://icheck.fronteed.com/
- Inputmask http://robinherbots.github.io/Inputmask/
- Ion range slider http://ionden.com/a/plugins/ion.rangeSlider/en.html
- JQuery https://jquery.com/
- JQuery asColorPicker https://github.com/thecreation/jquery-asColorPicker
- JQuery bar rating http://antenna.io/demo/jquery-bar-rating/examples/
- JQuery context menu http://swisnl.github.io/jQuery-contextMenu/
- JQuery file upload http://hayageek.com/docs/jquery-upload-file.php
- JQuery Mapael https://github.com/neveldo/mapael-maps
- JQuery sparklin http://omnipotent.net/jquery.sparkline/
- JQuery-steps http://www.jquery-steps.com/
- JQuery Tags Input http://xoxco.com/projects/code/tagsinput/
- JQuery Toast https://kamranahmed.info/toast
- JQuery Validation https://jqueryvalidation.org/
- JQuery Avgrund https://github.com/voronianski/jquery.avgrund.js
- JQuery Repeater http://briandetering.net/repeater
- JSgrid http://js-grid.com/
- JSgrid http://js-grid.com/
- Justgage http://justgage.com/
- JVector Map http://jvectormap.com/
- Light gallery http://sachinchoolur.github.io/lightGallery/
- Material Design Icons https://materialdesignicons.com/
- Moment.js https://momentjs.com/
- Morris.js https://momentjs.com/
- NoUISlider https://refreshless.com/nouislider/
- Owl carousel https://owlcarousel2.github.io/OwlCarousel2/docs/started-welcome.html
- Perfect scrollbar http://utatti.github.io/perfect-scrollbar/
- Popper.js https://popper.js.org/
- Progressbar.js https://progressbarjs.readthedocs.io
- PWS Tabs https://alexchizhov.com/pwstabs/
- Quill Editor https://quilljs.com/
- Rapheal http://dmitrybaranovskiy.github.io/raphael/
- Select 2 https://select2.org/
- Simple line icons http://simplelineicons.com/
- SimpleMDE https://simplemde.com/
- Summernote https://summernote.org/
- Sweetalert http://sweetalert.js.org
- Tempusdominus-bootstrap-4 https://tempusdominus.github.io/bootstrap-4/
- Themify icons https://themify.me/themify-icons
- TinyMCE https://www.tiny.cloud/
- TWBS pagination https://esimakin.github.io/twbs-pagination/
- Typeahead https://twitter.github.io/typeahead.js/
- Xeditable https://vitalets.github.io/x-editable/