Coder Social home page Coder Social logo

whiskerboard's Introduction

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 [email protected]: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.

whiskerboard's People

Contributors

jasonthomas avatar whd avatar sijis avatar bfirsh avatar jvasallo avatar johngruen avatar victortrac avatar

Stargazers

Jhon Wang avatar Mike Korcynski avatar

Watchers

 avatar James Cloos avatar  avatar  avatar

whiskerboard's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.