Skip to content

Getting Started

Jump to bottom
Dimitrios Zorbas edited this page Apr 27, 2017 · 7 revisions

The easiest way to get started with Kitto is to use the installer.

See: https://github.com/kittoframework/kitto#installation on how get the installer.

Run the installer

mix kitto.new <your_dashboard>

Jump to the created directory for your dashboard

cd <your_dashboard>

If you chose not to fetch dependencies during installation you can get them with:

mix deps.get # Elixir dependencies
npm install  # JavaScript dependencies

Start the server

mix kitto.server

Changes made to your assets will be reflected immediately by Webpacks' hot-module-replacement

The dashboard created with the installer comes with 2 sample dashboards.

The directory setup is:

  • assets — All your js,stylesheets to be used in your dashboards. Consult webpack.config.js to see how they're loaded.
  • dashboards — One .html.eex file for each dashboard.
  • jobs — Definitions on data retrieval actions. Their role is to provide data for the widgets.
  • lib — Elixir modules to be used by your jobs.
  • widgets — All the html/scss/js for individual widgets.

Further Reading

Below you can find a series of blog posts by @davejlong and @zorbash to help you make your first steps with Kitto.

Open-Source Dashboards Built With Kitto

Clone this wiki locally