Synopsis
Being able to see a visual timeline of a project provides great value and insight into the designing process. We thought it would be neat to be able to step back and forth between versions of project would be highly beneficial to both developer and various third parties. Project Heh allows you to visit between commits and see the visual state of the project at that time.
Code Example
You can navigate to the url http://vm64-114.iplantc.org/heh/ in your browser, andenter the owner and repo of a github project you would like to visit. We created a github pages demo for your convenience. At the top of the page, enter:
owner: loukitzanna repo: website-for-demo
Press "Get My Timeline!" to begin.
When the github pages project renders, using the arrows at the top, you should be able to step back and forth between commits, watching the project change with each commit. Arrows will disappear a result of hitting the end of a timeline.
Motivation
Github is a staple in the developer's toolbox. However, being able to track changes between projects in a meaningful way, especially with visualization, is functionality that designers and developers miss out on. Imagine a client looking at their designer's project, and being able to point out exactly which things worked in the last iteration, and which things needed to change in order to inform the newst changes. We wanted to be able to track the evolution of visually-based projects in a simple and intuitive way.
Installation
Make sure a webserver (apache is fine) is installed and edit the gulpfile.js to point to its desired location.
npm install
gulp
Contributors
Connor Osborn (cdosborn@email.arizona.edu Anna Loukianova (loukianova@email.arizona.edu) Andre Mercer (amercer1@email.arizona.edu)
License
Copyright (c) 2015, Connor Osborn All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
- Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
- Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
The views and conclusions contained in the software and documentation are those of the authors and should not be interpreted as representing official policies, either expressed or implied, of the FreeBSD Project.