Skip to content

jasonthomas/whiskerboard

 
 

Repository files navigation

Whiskerboard

Whiskerboard is a status board for websites, services and APIs, like Amazon's AWS status page.

It is heavily based on Stashboard. Unlike Stashboard, it uses vanilla Django, so you aren't stuck using Google App Engine.

Quick start guide

$ git clone git@github.com:jasonthomas/whiskerboard.git
$ cd whiskerboard
$ sudo pip install -r requirements.txt
$ Add a "SECRET_KEY = 'EnterABunchOfRandomCharactersHere'" to settings/base.py
    (Alternatively, use http://www.miniwebtool.com/django-secret-key-generator/ to create a secret key!)
$ ./manage.py syncdb
$ ./manage.py migrate
$ ./manage.py runserver

You might need to install pip. Back on the admin home page, click on "services" and add the things you want to report the status of (website, API etc). To change the status of a service add an event for it.

CSS

The CSS for this site is written in LESS and has several dependencies. To edit you will need NPM, Bower and Grunt installed.

brew install npm
npm install -g bower
npm install -g grunt

To modify CSS, begin by installing npm and bower dependencies from the whiskerboard directory.

npm install
bower install

The only files that should be manipulated are application_styles/main.less and application_styles/variables.less.

To compile changes to LESS, use the grunt command.

API Documentation

Visit the wiki page on details about the API.

You may also find useful the whiskerboard-tools repository.

About

A django based status board with an API

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 72.9%
  • CSS 14.8%
  • Python 12.3%