https://github.com/allegro/tipboard

Tipboard - in-house, tasty, local dashboarding system
https://github.com/allegro/tipboard

Last synced: about 2 months ago
JSON representation

Tipboard - in-house, tasty, local dashboarding system

• Host: GitHub
• URL: https://github.com/allegro/tipboard
• Owner: allegro
• License: other
• Created: 2014-08-25T10:39:46.000Z (about 10 years ago)
• Default Branch: develop
• Last Pushed: 2023-03-20T21:39:11.000Z (over 1 year ago)
• Last Synced: 2024-06-27T09:37:32.613Z (3 months ago)
• Language: JavaScript
• Homepage: http://allegro.github.io/tipboard/
• Size: 1.93 MB
• Stars: 1,104
• Watchers: 51
• Forks: 159
• Open Issues: 26
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGES.rst
  • License: LICENSE.rst

Awesome Lists containing this project

• awesome-hacktoberfest - Tipboard
• my-awesome-github-stars - allegro/tipboard - Tipboard - in-house, tasty, local dashboarding system (JavaScript)
• awesome-homelab - Tipboard - in-house, tasty, local dashboarding system | (Apps / X)

README

        
========

Tipboard

========

|docs|

Introduction

------------

Tipboard is a system for creating dashboards, written in JavaScript and Python.

Its widgets ('tiles' in Tipboard's terminology) are completely separated from

data sources, which provides great flexibility and relatively high degree of

possible customizations.

Because of its intended target (displaying various data and statistics in your

office), it is optimized for larger screens.

Similar projects: `Geckoboard `_,

`Dashing `_.

A detailed, technical documentation for Tipboard can be found

`here `_.

Quick start

-----------

Requirements

~~~~~~~~~~~~

Assuming Ubuntu or similar Linux distribution, some required packages need

to be installed first::

  $ sudo apt-get install python-dev python-virtualenv redis-server

Virtual environment

~~~~~~~~~~~~~~~~~~~

Continue by creating a virtual environment that will help you conveniently

separate your instance from what you already have installed in the system

(let's say we will name it "tb-env")::

  $ virtualenv tb-env

Activate the created virtual environment with the following command::

  $ source tb-env/bin/activate

Installation with pip

~~~~~~~~~~~~~~~~~~~~~

After creating and activating virtualenv, install the latest (current) version

of Tipboard package available on `pypi `_

("Python Package Index") with the following command::

  (tb-env)$ pip install tipboard

Next, you need to create a configuration template for your dashboard - let's

say we will call it 'my_test_dashboard'::

  (tb-env)$ tipboard create_project my_test_dashboard

This command will create ``.tipboard`` directory in your home dir and will

fill it with default settings for your dashboard.

Verification

~~~~~~~~~~~~

To verify your installation, launch this command::

  (tb-env)$ tipboard runserver

If you see the message ``Listening on port...`` instead of any errors, it means

that installation was successful and you may now

`configure `_

your newly installed Tipboard instance. You may also point your favorite

web browser to ``http://localhost:7272`` to see the current state of your

dashboard.

License

-------

Tipboard is licensed under the `Apache License, v2.0 `_.

Copyright (c) 2013-2017 `Allegro Group `_.

.. |docs| image:: https://readthedocs.org/projects/tipboard/badge/?version=latest

    :alt: Documentation Status

    :scale: 100%

    :target: https://readthedocs.org/projects/tipboard/