Giter Club home page Giter Club logo

dashboardify's Introduction

Dashboardify

Create dashboards using JSON providing a simple JSON schema to create a dashboard that can be shared with your team, company or users.

Creating a dashboard using JSON

Dashboardify lets you create dashboards using a JSON you provide via a URL. This JSON needs to be formatted in a specific way as shown below:

{
  "sections": [
    {
      "title": "Users",
      "stats": [
        {
          "label": "Total",
          "value": 1540
        },
        {
          "label": "Today",
          "value": 20
        },
        {
          "label": "Pro Users",
          "value": 125
        }
      ]
    },
    {
      "title": "Revenue",
      "stats": [
        {
          "label": "Total",
          "value": 8654,
          "prefix": "$"
        },
        {
          "label": "This month",
          "value": 804.5,
          "prefix": "$"
        },
        {
          "label": "MRR",
          "value": 968.43,
          "prefix": "$"
        }
      ]
    },
    {
      "title": "Requests",
      "table": {
        "columns": [
          "User",
          "Number of requests"
        ],
        "data": [
          [
            "[email protected]",
            3450
          ],
          [
            "[email protected]",
            2789
          ],
          [
            "[email protected]",
            2379
          ],
          [
            "[email protected]",
            1045
          ],
          [
            "[email protected]",
            875
          ],
          [
            "[email protected]",
            294
          ]
        ]
      }
    }
  ]
}

As you can see, the dashboard is made up of sections that can have stats, table and a chart. To see the dashboard generated by this example, you can go to the dashboard page.

Schema

To start the schema, you must define the sections you want to show.

ATTRIBUTE TYPE REQUIRED
sections Array of Section Yes

Section

Sections are how Dashboardify groups information. You can have everything in the same section or create different ones for each context, like "Users", "Recipe", "Requests", etc.

ATTRIBUTE TYPE REQUIRED
title String Yes
stats Array of Stat No
table Table No
chart Chart No

Stat

A stat is used to display numbers as metrics and monetary values.

ATTRIBUTE TYPE REQUIRED
label String Yes
value Number Yes
prefix String No

Table

A table is used to display tabular data. It's useful when you have a list of values you want to see at once.

ATTRIBUTE TYPE REQUIRED
columns Array of String Yes
data Array of Array of String or Number Yes

Chart

Display a line chart with x and y defined values.

ATTRIBUTE TYPE REQUIRED
label String Yes
type "linear" Yes
lines Array of Line Yes

Chart line

ATTRIBUTE TYPE REQUIRED
id String Yes
color String Yes
data Array of Values Yes

Chart values

ATTRIBUTE TYPE REQUIRED
x String Yes
y Number Yes

dashboardify's People

Contributors

brunoquaresma avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Forkers

hirajanwin

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.