https://github.com/criteo/slab

An extensible Scala framework for creating monitoring dashboards.
https://github.com/criteo/slab

dashboard monitoring observability scala web-app

Last synced: 6 months ago
JSON representation

An extensible Scala framework for creating monitoring dashboards.

• Host: GitHub
• URL: https://github.com/criteo/slab
• Owner: criteo
• License: apache-2.0
• Created: 2017-04-28T07:07:11.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2023-01-12T08:38:04.000Z (almost 3 years ago)
• Last Synced: 2024-04-13T05:52:23.440Z (over 1 year ago)
• Topics: dashboard, monitoring, observability, scala, web-app
• Language: Scala
• Homepage:
• Size: 7.6 MB
• Stars: 22
• Watchers: 15
• Forks: 9
• Open Issues: 15
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Slab 

[![Build Status](https://travis-ci.org/criteo/slab.svg?branch=master)](https://travis-ci.org/criteo/slab)

[![Latest version](https://index.scala-lang.org/criteo/slab/slab/latest.svg)](https://index.scala-lang.org/criteo/slab/slab)

[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

An extensible Scala framework for creating monitoring dashboards.

![screencast](https://criteo.github.io/slab/public/slab.gif)

## Installation

Add the following to your project's dependencies:

- sbt

    `"com.criteo" %% "slab" % "latest.release"`

- Maven

    ```xml

    

        com.criteo

        slab_${SCALA_SHORT_VERSION}

        LATEST

    

    ```

Slab is available for Scala `2.11` and `2.12`

## Getting started

The easiest way to get started is to follow the guides:

- [Guide for creating a Slab board](https://criteo.github.com/slab/examples/SimpleBoard.scala.html)

- [Guide for creating a Slab server](https://criteo.github.com/slab/examples/Launcher.scala.html)

The documentation is also available:

- [API documentation](https://criteo.github.com/slab/api/com/criteo/slab)

## Running the example project

Ensure you have sbt and npm installed and then:

```

$> npm install

$> npm start

```

## Contribution

Please read the [contribution guide](/CONTRIBUTING.md)

## License

Licensed under the [Apache License 2.0](/LICENSE)

## Copyright

Copyright © Criteo, 2017.