Skip to content
This repository has been archived by the owner on Nov 9, 2018. It is now read-only.

Latest commit

 

History

History
67 lines (56 loc) · 2.34 KB

README.md

File metadata and controls

67 lines (56 loc) · 2.34 KB
Raw

zf-admin

ZF-Admin is a simple starter template for building admin or dashboard interfaces.

Motivation

I wanted a Zurb Foundation based template with just a minimum amount of features and a proper build system.

Features

  • Plugins: Datepickers, graphs, notifications e.t.c
  • Asset managememt using Bower
  • Build system using Gulp
  • Templating system using Jquery.loadTemplate

These features can be configured and are not mandatory.

You can view the dashboard examples by changing intto the "examples" folder and running a server application like http-server or live-server.

Usage

Clone this repository or npm install zf-admin or bower install zf-admin

Using the zf-admin template with the dev/ build system

  1. Run "npm install".
  2. Run "bower install".
  3. Modify the gulpfile.js as needed.
  4. Modify the source SASS and JS files as needed.
  5. Run Gulp to build assets.

Using the admin template with default dependencies.

Check out the example folder to see how to use the template as is. You can still customize as you see fit. It just would not be as flexible.

Provided plugins

  1. Charting. chart.js
  2. Animated counters. countup.js
  3. Date/ Time picker. flatpickr
  4. Notifications. Noty
  5. Simple templating. jQuery.loadTemplate
  6. Lightbox. Responsive-Lightbox
  7. Alerts and modal dialogs. sweetalert2
  8. Data tables. datatables

Available build tasks

Run "gulp help" to see a list of all the available build tasks:

Main Tasks

default
help

Sub Tasks

build-all
build-js
build-sass
copy-fonts
lint-js
prepare-default-images
prepare-example-assets