https://github.com/pvande/tranquil
https://github.com/pvande/tranquil
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/pvande/tranquil
- Owner: pvande
- Created: 2011-05-17T05:10:00.000Z (about 14 years ago)
- Default Branch: master
- Last Pushed: 2012-10-24T04:32:22.000Z (over 12 years ago)
- Last Synced: 2024-10-10T20:18:07.018Z (8 months ago)
- Language: JavaScript
- Homepage:
- Size: 1.56 MB
- Stars: 34
- Watchers: 4
- Forks: 8
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Tranquil
========
Tranquil is an app that acts as a basic framework for building status
boards like the one used by
[Panic](http://www.panic.com/blog/2010/03/the-panic-status-board/). Started on
a whim, it's intended to provide enough flexibility for almost anyone -- even
without a local installation.
Principle
---------
Your status board is defined by a basic configuration file, which is specified
as a JSON hash. This file (`/config.json`, by default) will be loaded via
JSONP, and will be polled periodically for changes (automatically refreshing
your status board). Alternate configurations can be loaded by specifying the
`config` query parameter.
The `javascript` and `stylesheet` keys may be supplied as arrays of filenames;
these files will be loaded iff the exact filename has not already been loaded.
The `layout` key should refer to an array, each element corresponding to a
'row' in the board's layout. Elements in the `layout` array may be arrays of
'panels' (which will be distributed equitably across the width of the board),
or individual 'panel' objects (which receive the full width).
The different types of 'panels' are described in the
[wiki](https://github.com/pvande/Tranquil/wiki/Types).