Getting Started with uberboard

Initialize Your Dashboard

If you haven't already installed the uberboard-cli tool, you can find the different installation options for MacOS, Linux, and Windows on this page. Once the uberboard is installed, you can initialize a new dashboard project by running:

uberboard dashboard create my-dashboard

Replace 'my-dashboard' with your desired project name. This command creates a new directory with the necessary files to get started with your dashboard.

Create a View

A view in uberboard represents a specific layout or part of your dashboard that displays widgets or data elements. To create a new view, use the uberboard CLI again:

uberboard views create my-view

Replace 'my-view' with a name for your view. After creating the view, you can configure it by adding widgets or specifying data sources.

Configure a Shipper

Shippers are responsible for collecting, processing, and sending data to your dashboard. To set up a shipper, you'll need to configure it based on your data source and requirements. This typically involves editing a configuration file or using the uberboard-cli to specify data sources, formats, and other settings.

uberboard shippers create my-shipper

Add Shipper And View To Your Dashboard

With your view created and shipper configured, you're now ready to use it in your dashboard. Edit dashboard.hbs in the root of your dashboard folder and add the following line:

<div data-widget data-view="my-view" data-shipper="my-shipper"></div>

Start Your Dashboard

With your view created and shipper configured, you're now ready to start your dashboard:

uberboard start

This command launches your dashboard, making it accessible for you to view and interact with the data and widgets you've configured.