rickhanlonii / stashboard

An open-source status dashboard running on App Engine

Stashboard

Stashboard was written by Twilio to provide status information on our phone, SMS, and Communication APIs. We open sourced the code to provide a generic status page designed to be customized by any hosted services company to provide customers up-to-date status information. The code can be downloaded, customized with your logo, and run on any Google App Engine account.

Installation

1. Download and install the App Engine SDK for Python
2. git clone git://github.com/twilio/stashboard.git
3. Add your application id to app.yaml
4. Open the SDK, choose File > Add Existing Application... and select the stashboard folder inside the cloned repository
5. Update the settings in settings.py
6. Visit http://your-app-id.appspot.com/admin/setup to complete the installation

From here you can either run Stashboard locally in the App Engine development environment or deploy to Appspot. See the Getting Started guide for a basic overview of the App Engine platform.

Demo

The most recent version of Stashboard lives at http://stashboard.appspot.com

Documentation

Full documentation can be found on Read The Docs

Community

All Stashboard development and discussion happens in the Stashboard google group

To keep up to date, you can follow @stashboard on Twitter or join the #stashboard channel on freenode

Development

You'll need to install a couple more packages to hack on Stashboard

pip install -r requirements.txt

To run the unit tests,

python tests/runner.py tests

Future

The roadmap details future plans for Stashboard.

Acknowledgements

• Buttons by Necolas
• Fugue icons by Yusuke Kamiyamane
• Iconic icons by P.J. Onori
• OAuth support via simplegeo/python-oauth2