Skip to content

Latest commit

 

History

History
59 lines (38 loc) · 3.78 KB

readme.md

File metadata and controls

59 lines (38 loc) · 3.78 KB
Raw

Grandstand: Visualize your Sprints

Sprint.ly is a great tool for Agile development, however it can be difficult to get a good sense of the size of your queue and how stories, tasks, and defects are distributed among your team.

Screenshot

Based on Scrumly with interaction and visualization help from Isotope, with Grandstand your Sprint.ly items are sized by their score, colored by their type, and arranged in a masonry grid. You can filter your project's items by user, status, type, and score.

Grandstand in action...

Animated screenshot

Setup

Getting started is simple, assuming you have a Sprint.ly account:

  1. Clone this repository recursively (git clone --recursive [email protected]:andrewliebchen/Grandstand.git). Without the --recursive flag, you won't get the necessary submodule.
  2. Clone or download this repo.
  3. Open resources/config.template.php, fill in your Sprint.ly user, product, and API key information.
  4. Save this file as config.php.
  5. Setup the files on a webserver, or run locally with MAMP.
  6. Open index.php in your favorite browser.

Heroku

Grandstand can easily be deployed to Heroku, but you probably don't want to put your Sprintly API key in source control. To allow you to deploy to Heroku securly, Grandstand will fall back to using environment variables for its configuration so you can use heroku config to set them.

  1. Clone this repository recursively (git clone --recursive [email protected]:andrewliebchen/Grandstand.git). Without the --recursive flag, you won't get the necessary submodule.
  2. Setup a new Heroku application and procure its git repository URL.
  3. Add that repo as a remote for your local clone: get remote add heroku [email protected]:your-app-url.git
  4. Make sure that you have the Heroku gem or toolbelt: gem install heroku
  5. Set your Grandstand configuration on Heroku. See config.template.php for info on the required variables. Example: heroku config:set [email protected] api_key=asdfqwerty1234 product_id=5555 product_name=myproduct
  6. Deploy: git push heroku master
  7. Visit the Heroku application in your favorite browser.

Other deployed environments

You're mostly on your own. You can use environment variables to setup your Grandstand configuration. See Heroku above for more information.

Contributing?

This project uses Grunt to compile Sass to CSS, concatenate, minify, and uglify the JavaScript, and watches for changes to these files. If you're working on this project, run npm install in the project directory, and once the packages installs, run grunt.

To do

This project goal is to experiment with new ways of visualizing and interacting with an Agile queue beyond the standard column layout. Grandstand should be improved to make better use of the more functionality offered by the Sprint.ly API. Additional features that would make Grandstand more useful (these and and other odds and ends are in issues):

  • Sort items by number, date added, activity, etc.
  • Display item meta information beyond number and title.
  • Build a configuration pane to allow users to input information for their own projects. With this feature, there could be a publicaly accessible demo.
  • Filter on multiple parameters within the same dimension.
  • Figure out how to get around the 100 item API limit. Thanks, @t1mmen!

Contributers

Thanks for pitching in: