<a href="http://opensource.org/licenses/MIT" target="_blank"><img src="http://img.shields.io/badge/license-MIT-blue.svg?style=flat" alt="License" align="right" hspace="2" /></a>
<a href="https://github.com/gizmoboard/gizmoboard/releases" target="_blank"><img src="http://img.shields.io/badge/release-0.0.3-blue.svg?style=flat" alt="Current Release" align="right" hspace="2" /></a>

Gizmoboard is a metadata collector and visualizier intended to provide easy-to-setup, configurable dashboards for all areas of business. You want to know what your data is telling you, and you want to know in real time - Gizmoboard can help with that.

Gizmoboard is built so you can run multiple dashboards off of a single, centralized data source, or run it self contained directly out of the box. You can run hundreds of dashboards off a single server, or setup a RaspberryPi and run it on your desk. The configuration is up to you.

We believe in quality code, and we want your help. We encourage everyone to assist in any way, whether it be opening an issue requesting your latest idea, or submitting a pull request and contributing to the code.

Code Quality Report

Before We Begin...

Gizmoboard is a lot of things, but it is not everything.

Gizmoboard is not a full-service data solution. It won't collect or enrich your data, it won't replace your data warehouse any time soon, and it won't hand you knowledge. You have to know what questions you're asking before Gizmoboard becomes useful, and you have to have good, clean data coming in to get that in order.

If you want a system that can collect terrabytes of data and analyze it for you, Gizmoboard is not it. If you, however, already have that data and are looking for an easy way to visualize it, you've come to the right place. Give us your metadata, and we'll give you something you can sink your teeth into.

met·a·da·ta noun

a set of data that describes and gives information about other data.

Quickstart

Gizmoboard comes with a few components out of the box, but is highly configurable with community-driven plugins. The entire platform is built on top of Node.js, and is built from the ground up for automation.

These instructions will be available upon release 0.0.1

Developer Installation

So you're looking to get your hands dirty? You've come to the right place. We work our hardest to provide a quick install for developers, as well. When you've completed your masterpiece, give our Contribution Guidelines a look over and send us a pull request!

Install Node.js or io.js

We currently have tested and developed on Node.js v0.12, and remains our official support platform. We do, however, run our travis-ci scripts against both Node.js and io.js, so give it a try!

Install Gizmoboard

The master branch is the bleeding-edge development branch, and not recommended for production solutions. If you want to deploy from git, check out a stable release instead!

# Checkout Gizmoboard
git checkout https://github.com/gizmoboard/gizmoboard
cd gizmoboard

# Ensure that grunt is installed globally
npm install -g grunt-cli

# Run the NPM installer for the project
npm install

# Run the grunt installation tasks
grunt init

# Start Gizmoboard!
npm start

Configuring

Coming soon!

Setting Up a Data Source

Coming soon!

Setting Up a Dashboard

Coming soon!

Deploying

Coming soon!

Deploying with a Centralized System

Coming soon!

Release Policy

Releases of Gizmoboard follow a maj.min.rev versioning scheme of the following format:

• maj - major version - modified for major, often non-backwards compatible, releases
• min - minor version - modified for feature releases and updates
• rev - revision version - modified for bug fixes, security patches, and documentation

As such, it is recommended that you keep your revision up to date when using Gizmoboard in a package.json file. For instance, a sample may look like:

{
	"dependencies": {
		"gizmoboard": "1.0.*"
	}
}

This will ensure that your package always has the latest security patches and bug fixes for the functionality that you have built your project around.

License

Please refer to the Gizmoboard license agreement.