README.md

Admintool

Software:

• ubuntu /14.04.1
• nginx /1.4.6

Dependecies:

• jQuery /2.2.2
• bootstrap /3.3.6
• amivaccess /1.0

File Structure:

• admin (Admintool)
  • lib (Libraries)
    • bootstrap
    • jquery
    • amiv (amivcore)
    • cust (custom files)
      • main.js (our js file)
      • main.css (our css file)
  • res (Resources)
    • bg (big pictures and backgrounds)
    • favicon
    • fonts
    • logo
  • tools (tools)
    • main.tool
    • users.tool
    • ...
• public (Website)

Library tools:

The JS library tools is the backbone of the single tools. It enables the tool itself to take actions, such as store data, customize the menu, spawn alert boxes, load new tools and more.

log(msg, type, timeout)

Displays an alert box to the user.

• msg /text,HTML The message or html to be displayed in the alert box
• type /('s', 'i', 'w', 'e') Specifies the type of message. Displays different colors for each type.
  • s: success
  • i: information
  • w: warning
  • e: error
• timeout /int (optional) Number of milliseconds that the message will be displayed. If not specified the default time is 5s, or 5000ms.

Example:

• tools.log('User updated!', 's'); Creates a green alert box with the message specified that will disappear after 5000ms.
• tools.log('Error!', 'e', 10000); Creates a gred alert box with the message specified that will disappear after 10s.

modal(data)

Spwans a BS modal.

• data /js object Object containning the infos
  • head /text, HTML (optional) Sets the modal title.
  • body /text, HTML (optional) Sets the modal body.
  • button /text, HTML (optional) Confirm button text.
  • success /function (optional) Function called on confirm button press.
  • cancel /function (optional) Function called on cancel or modal is closed.

Example:

tools.modal(); 
//Creates an empty modal.

tools.modal({
	head: 'Download Flash Player!!',
	body: 'Your browser needs this super important plugin',
	button: 'DOWNLOAD!',
	success: function(){
		some.nasty.virus();
	},
	cancel: function(){
		console.log('No Virus for you -.-');
	}
});
// Makes a modal to download stuff

getTool(tool)

Loads the specified tool. If no tool is specified the tool in the navigaton bar (hashtag) will be chosen.

• tool /text (optional) Specifies the tool.

Example:

• tools.getTool('home'); Will get the /res/tools/home.tool and loads it into the site.

ui

The ui element allows you to access ui components (menu) and take actions (login, logout, toggleSideMenu).

toggleSideMenu()

Example:

• tools.ui.toggleSideMenu(); Toggles the sidebar.

menu(object)