| #GovHack Toolkit |
#GovHack Toolkit |
| Welcome to the GovHack toolkit. This page provides all the information you need to prepare hackfest entries. |
Welcome to the GovHack toolkit. This page provides all the information you need to prepare hackfest entries. |
| These tools can be used to make entries like: mobile apps, web apps, data visualisations/infographics. |
These tools can be used to make entries like mobile apps, web apps and data visualisations/infographics. |
| This toolkit is open source, licenced cc-by and improvements are encouraged ... |
|
| |
The text of this toolkit is open for reuse under a Creative Commons Attribution licence and improvements are encouraged via Git http://github.com/maxious/govhack-tools or via email patches to govhack@lambdacomplex.org |
| |
|
| # How to register and submit your entry |
# How to register and submit your entry |
| ## Registering your team |
## Registering your team |
| Coming Soon: how to use the website "Hacker Space" to register and find teams. |
Coming Soon: how to use the website "Hacker Space" to register and find teams. |
| |
|
| ## Preparing your submission |
## Preparing your submission |
| |
|
| You should record a 3 minute speech and mix images/text to accompany. |
You should record a 3 minute speech and mix images/text to accompany. |
| http://www.screenr.com/ and other screencasting tools allow you to demo apps. |
[Screenr] (http://www.screenr.com/) , [ActivePresenter Free Edition](http://atomisystems.com/activepresenter/free-edition/) and other screencasting tools allow you to demo apps. |
| To mix together clips, you can use youtube video editor http://www.youtube.com/editor or local software like http://www.videolan.org/vlmc/ or http://www.lwks.com/ |
To mix together clips, you can use youtube video editor http://www.youtube.com/editor or local software like http://www.videolan.org/vlmc/ or http://www.lwks.com/ |
| |
|
| You also need to submit your "source material". For an application this may be source code, for another work it might be your notes or prototypes. |
You also need to submit your "source material". For an application this may be source code, for another work it might be your notes or prototypes. |
| The key thing here is that your source material demonstrates to the judges that some of the end result was your own work and that it is possible for another person to replicate that work. |
The key thing here is that your source material demonstrates to the judges that some of the end result was your own work and that it is possible for another person to replicate that work. |
| |
|
| |
|
| # General References {#general-data-hacking-and-programming-references} |
# General References |
| |
|
| ## Who can be a hack day participant |
|
| There are many roles you can play; coder, designer UX/graphics |
|
| |
|
| ## Definitions |
|
| - definitions, open licence reuse permissive hacker hack data journalism data vis UX etc. |
|
| |
|
| ## The basics of being a data scientist |
## The basics of being a data scientist |
| |
|
| * Have a hypothesis - even if you're making a tool/api that helps people with their questions too, remember what the objective of that is. |
* Have a hypothesis - even if you're making a tool/api that helps people with their questions too, remember what the objective of that is. |
| * Find the people and tools you need to prove/show/find. This rest of this page will help with the latter. |
* Find the people and tools you need to prove/show/find. This rest of this page will help with the latter. |
| * Analyse and present results - were they what you expected? Do they help explain to others what you have found out? |
* Analyse and present results - were they what you expected? Do they help explain to others what you have found out? |
| Can present as a interactive data visualisation or a web/mobile application or just a infographic/motion graphics video that tells a story. |
Can present as a interactive data visualisation or a web/mobile application or just a infographic/motion graphics video that tells a story. |
| |
|
| [](img/How-to-participate-in-GovHack_html_m6a65720f.gif)</dt> |
[](img/How-to-participate-in-GovHack_html_m6a65720f.gif)</dt> |
| Illustration from Data Journalism Handbook, CC BY-SA 3.0</dd> |
Illustration from Data Journalism Handbook, CC BY-SA 3.0</dd> |
| |
|
| The best high level reference is the 'Understanding Data' and 'Delivering Data' chapters of the Data Journalism Handbook which is available online for free at |
The best high level reference is the 'Understanding Data' and 'Delivering Data' chapters of the Data Journalism Handbook which is available online for free at |
| [datajournalismhandbook.org](http://datajournalismhandbook.org/) |
[datajournalismhandbook.org](http://datajournalismhandbook.org/) |
| |
|
| You can learn the technical skills from scratch in Visualize This: The FlowingData Guide to Design, Visualization, and Statistics by Nathan Yau or for more advanced |
You can learn the technical skills from scratch in Visualize This: The FlowingData Guide to Design, Visualization, and Statistics by Nathan Yau or for more advanced |
| practical advice check out Data Analysis with Open Source Tools by Philipp K. Janert |
practical advice check out Data Analysis with Open Source Tools by Philipp K. Janert |
| For further reading in this space |
For further reading in this space |
| [http://flowingdata.com/2012/04/27/data-and-visualization-blogs-worth-following/](http://flowingdata.com/2012/04/27/data-and-visualization-blogs-worth-following/) |
[http://flowingdata.com/2012/04/27/data-and-visualization-blogs-worth-following/](http://flowingdata.com/2012/04/27/data-and-visualization-blogs-worth-following/) |
| |
|
| |
|
| **Statistics** |
**Statistics** |
| [http://greenteapress.com/thinkstats/html/index.html](http://greenteapress.com/thinkstats/html/index.html) |
|
| |
A great guide to statistics is |
| |
[Think Stats](http://greenteapress.com/thinkstats/html/index.html) |
| |
|
| **Programming** |
**Programming** |
| |
|
| Programming is valuable skill for manipulating and displaying data. |
Programming is valuable skill for manipulating and displaying data. |
| Basic tutorials for a variety of languages are available for free online or you can learn |
Basic tutorials for a variety of languages are available for free online or you can learn interactively with websites like [Codecademy for JavaScript](http://www.codecademy.com/#!/exercises/0), [Learn Python](http://www.learnpython.org/) or [Try Ruby](http://tryruby.org/) |
| |
|
| interactively with websites like [http://www.codecademy.com/](http://www.codecademy.com/#!/exercises/0). for JavaScript or [http://www.learnpython.org/ ](http://www.learnpython.org/)or [http://tryruby.org](http://tryruby.org/) |
For web applications and visualisations, you'll need a basic understanding of JavaScript in order to configure pre made libraries like jQuery. A good source for Javascript information is the [Mozilla Development Network Javascript Page](https://developer.mozilla.org/en/JavaScript) |
| |
|
| [https://developer.mozilla.org/en/JavaScript](https://developer.mozilla.org/en/JavaScript) - especially for web applications and visualisations, you'll need a basic understanding of JS. Common libraries like prototype or jQuery can help |
|
| |
|
| **Accessibility/User Experience** |
**Accessibility/User Experience** |
| |
|
| WCAG guidelines not only make a web app accessible but make it a better experience for all users! Even if not making an app, good to consider these things to do and not do: [http://www.w3.org/TR/WCAG/](http://www.w3.org/TR/WCAG/) |
Following accessibility guidelines not only make a application accessible but make it a better experience for all users! Even if not making an app, good to consider these things to do and not do when designing for humans: [http://www.w3.org/TR/WCAG/](http://www.w3.org/TR/WCAG/) |
| |
|
| |
|
| |
|
| # Developer Tools For Your Computer {#developer-tools-for-your-computer} |
# Developer Tools For Your Computer |
| No matter what kind of application you have for the data, there are many tools you can use to better collaborate and manage your project. |
No matter what kind of application you have for the data, there are many tools you can use to better collaborate and manage your project. |
| |
|
| ### Source Control |
### Source Control |
| Git / Subversion |
Using a version control system like Git or Subversion allows you to keep many different versions of what you have been working on so you can collaborate with others or simply back up your files so you don't lose them! |
| |
|
| [](http://progit.org/book/) |
[](http://progit.org/book/) |
| |
|
| [http://progit.org/book/](http://progit.org/book/) |
There are [tutorials on git](http://progit.org/book/) and GUIs to help you like [TortoiseGit for Windows](http://code.google.com/p/tortoisegit/) and [Atlassian SourceTree for Windows and OSX](http://sourcetreeapp.com/) (or if you prefer the console [tig](http://blogs.atlassian.com/2013/05/git-tig/)) |
| |
There is also a [manual for Subversion](http://svnbook.red-bean.com/) and a [similar GUI for Subversion](http://tortoisesvn.net/) |
| [http://svnbook.red-bean.com/](http://svnbook.red-bean.com/) |
|
| |
|
| [http://tortoisesvn.net/](http://tortoisesvn.net/) |
### Task Tracking |
| |
|
| [http://code.google.com/p/tortoisegit/](http://code.google.com/p/tortoisegit/) |
|
| |
|
| ### Task Tracking - |
|
| |
|
| Issue/task trackers allow you to outline the tasks required for your project and assign them to people to do. |
Issue/task trackers allow you to outline the tasks required for your project and assign them to people to do. |
| |
|
| [Trello](https://trello.com/) and [Workflowy](https://workflowy.com/) are free, lightweight project management tools suitable for a rapid project! |
[Trello](https://trello.com/) and [Workflowy](https://workflowy.com/) are free, lightweight project management tools suitable for a rapid project! |
| |
|
| ## Hosted Developer Tools {#hosted-developer-tools} |
## Virtual Servers |
| |
Many free services to try out virtual/cloud servers before scaling up: https://www.chunkhost.com/ or heroku or https://www.appfog.com/pricing/ |
| Can get many tools (source control, issue tracking) combined into one service cloud hosted so no setup required. |
|
| |
## Hosted Developer Tools |
| ### Github |
|
| Git obviously but svn/hg interfaces are possible. Provide their own GUI for Windows/OSX or use the variety of Git capable tools |
Can get many tools (source control, issue tracking) combined into one service cloud hosted so there's no setup required. |
| |
|
| |
### Github / BitBucket |
| |
Github provides Git but [Subversion (svn)](https://github.com/blog/626-announcing-svn-support) and [Mercurial (hg)](http://hg-git.github.io/) interfaces are also available. Github provide their own GUI for Windows/OSX or you can use a variety of Git capable tools https://github.com/ |
| |
Similarly Atlassian provide BitBucket accessible via Git and Mercurial (hg) https://bitbucket.org/ |
| |
|
| ### Sourceforge |
### Sourceforge |
| |
|
| Subversion, Git, Mercurial, Bazaar, CVS, issue tracker, wiki, release file downloads. Unlimited free use for open source projects. |
Subversion, Git, Mercurial, Bazaar, CVS, issue tracker, wiki, release file downloads. Unlimited free use for open source projects. |
| |
|
| You can create your own Sourceforge project at [http://sourceforge.net/](http://sourceforge.net/) |
You can create your own Sourceforge project at [http://sourceforge.net/](http://sourceforge.net/) |
| |
|
| ### Google Code Project Hosting |
### Google Code Project Hosting |
| |
|
| Git, Mercurial, and Subversion code. Issue tracker, wiki, release file downloads. Unlimited free use for open source projects. |
Git, Mercurial, and Subversion code. Issue tracker, wiki, release file downloads. Unlimited free use for open source projects. |
| |
|
| You can host your Google Code project and get access to developer tools, APIs and documentation at [http://code.google.com/](http://code.google.com/) |
You can host your Google Code project and get access to developer tools, APIs and documentation at [http://code.google.com/](http://code.google.com/) |
| |
|
| |
|
| # Applications of data hacking |
# Applications of data hacking |
| |
|
| ## API Development {#api-development} |
## API Development |
| |
|
| |
|
| So an API isn't just an XML file  |
So an API isn't just an XML file! |
| |
|
| A good web based data API: |
A good web based data API: |
| |
|
| * Is logically organised |
* Is logically organised |
| * Can filter returned data |
* Can filter returned data |
| * Can return results in different open formats (CSV/JSON etc.) |
* Can return results in different open formats (CSV/JSON etc.) |
| * Is efficient and responsive by using caching and databases appropriately |
* Is efficient and responsive by using caching and databases appropriately |
| * Handles errors gracefully |
* Handles errors gracefully |
| * Monitors and controls access (to show benefit realised of API and prevent abuse) |
* Monitors and controls access (to show benefit realised of API and prevent abuse) |
| * Provides appropriate documentation with examples |
* Provides appropriate documentation with examples |
| |
|
| Some people like sensis [http://](http://developers.sensis.com.au/)[developers.sensis.com.<wbr>au</wbr>](http://developers.sensis.com.au/)[/](http://developers.sensis.com.au/) use a provider like[http://](http://mashery.com/)[mashery.com](http://mashery.com/)[/](http://mashery.com/) or [https](https://apigee.com/)[://](https://apigee.com/)[apigee.com](https://apigee.com/) or [http://](http://apiaxle.com/)[apiaxle.com](http://apiaxle.com/)[/](http://apiaxle.com/) or [http://www.3scale.net/](http://www.3scale.net/) which handles making a good API for them. |
Some people like sensis [http://](http://developers.sensis.com.au/)[developers.sensis.com.<wbr>au</wbr>](http://developers.sensis.com.au/)[/](http://developers.sensis.com.au/) use a provider like[http://](http://mashery.com/)[mashery.com](http://mashery.com/)[/](http://mashery.com/) or [https](https://apigee.com/)[://](https://apigee.com/)[apigee.com](https://apigee.com/) or [http://](http://apiaxle.com/)[apiaxle.com](http://apiaxle.com/)[/](http://apiaxle.com/) or [http://www.3scale.net/](http://www.3scale.net/) which handles making a good API for them. |
| |
|
| Atlassian have a great page on what makes a good API https://developer.atlassian.com/display/REST/Atlassian+REST+API+Design+Guidelines+version+1) |
Atlassian have a great page on what makes a good API https://developer.atlassian.com/display/REST/Atlassian+REST+API+Design+Guidelines+version+1) |
| |
|
| API |
HowTo.gov has a bunch of api resources about choosing SOAP vs. REST etc. http://www.howto.gov/mobile/apis-in-government |
| - howto.gov api resources about choosing SOAP vs. REST etc. http://www.howto.gov/mobile/apis-in-government |
|
| - http://training.sunlightfoundation.com/module/data-visualizations-google-docs/ |
API documentation is important too! Traditionally for SOAP APIs, you use WSDL but for REST try [Swagger](http://swagger.wordnik.com/) or [iodocs](https://github.com/mashery/iodocs) |
| - api documentation is important too. |
Many web app frameworks can generate the documentation for you. For example Symfony for PHP http://symfony.com/ https://github.com/FriendsOfSymfony/FOSRestBundle http://williamdurand.fr/2012/08/02/rest-apis-with-symfony2-the-right-way/ https://github.com/nelmio/NelmioApiDocBundle https://github.com/liip/LiipHelloBundle |
| - WSDL or http://swagger.wordnik.com/ or https://github.com/mashery/iodocs |
Or for Ruby on Rails there is is https://github.com/elc/rapi_doc https://github.com/Pajk/apipie-rails |
| - Many web app frameworks can generate the documentation for you. For example Symfony for PHPhttp://symfony.com/ https://github.com/FriendsOfSymfony/FOSRestBundle http://williamdurand.fr/2012/08/02/rest-apis-with-symfony2-the-right-way/ https://github.com/nelmio/NelmioApiDocBundle better apis https://github.com/liip/LiipHelloBundle |
|
| - or for Rails https://github.com/elc/rapi_doc https://github.com/Pajk/apipie-rails |
For example [Stripe's API](http://amberonrails.com/building-stripes-api/) or previous GovHack entrant [WeatheredOak](http://www.govhack.org/2012/06/02/weatheredoak/) |
| - |
|
| http://amberonrails.com/building-stripes-api/ |
|
| example WeatherTree weather API |
## Infographics and Data Visualisation |
| |
|
| |
|
| ## Infographics and Data Visualisation {#data-visualisation} |
|
| |
|
| Infographics try to contextualise charts and graphs to tell a story. Data vis builds on this to find new ways to design insight. |
Infographics try to contextualise charts and graphs to tell a story. Data vis builds on this to find new ways to design insight. |
| |
|
| Most of the categories to follow have visualisation tools specific to their purpose. |
Most of the categories to follow have visualisation tools specific to their purpose. |
| |
|
| You can find some data visualisation tools below: |
You can find some data visualisation tools below: |
| |
|
| [http://www.visualisingdata.com/index.php/2011/07/part-6-the-essential-collection-of-visualisation-resources/](http://www.visualisingdata.com/index.php/2011/07/part-6-the-essential-collection-of-visualisation-resources/) |
[Essential Colletion](http://www.visualisingdata.com/index.php/2011/07/part-6-the-essential-collection-of-visualisation-resources/) |
| |
[Drawing By Numbers Tools and Resources](http://drawingbynumbers.org/toolsandresources) |
| |
- http://selection.datavisualization.ch/ data viz tools catalog |
| Also check out [http://thejit.org](http://thejit.org/) & [http://www.senchalabs.org/<wbr>philogl/</wbr>](http://www.senchalabs.org/philogl/) (contributed by Matt Adcock) |
Also check out [http://thejit.org](http://thejit.org/) & [http://www.senchalabs.org/<wbr>philogl/</wbr>](http://www.senchalabs.org/philogl/) (contributed by Matt Adcock) |
| |
|
| Have to use visual art concepts, good color schemes http://www.r-bloggers.com/the-paul-tol-21-color-salute/ |
A good infographic should use visual art concepts and [good color schemes](http://www.r-bloggers.com/the-paul-tol-21-color-salute/). See the [data visualisation guidelines from the international journalism festival](http://schoolofdata.org/2013/04/26/data-visualization-guidelines-by-gregor-aisch-international-journalism-festival/) |
| |
For more information on the theory of data visualisation check out the [Stanford CS448B notes](https://graphics.stanford.edu/wikis/cs448b-12-fall/) or [The Ultimate Collection of Data Storytelling Resources](http://www.juiceanalytics.com/writing/the-ultimate-collection-of-data-storytelling-resources/) |
| |
|
| - https://graphics.stanford.edu/wikis/cs448b-12-fall/ data viz theory |
Some examples of data visualisation can be seen on [the Sunlight Foundation tumblr](http://sunfoundation.tumblr.com/) or at the GovHack alumn [The Open Budget](http://www/.theopenbudget.org) |
| - http://drawingbynumbers.org/toolsandresources |
|
| |
|
| examples - http://sunfoundation.tumblr.com/ |
|
| ## The Open Budget |
|
| |
|
| tools - http://selection.datavisualization.ch/ data viz tools catalog |
|
| |
|
| ## Web Applications |
## Web Applications |
| |
|
| With the rise of HTML5 technologies it is easier than ever to make a web application for engaging use of data. |
With the rise of HTML5 technologies it is easier than ever to make a web application for engaging use of data. |
| |
It's easy to quickly make a good looking and accessible webpage if you use a CSS framework like Bootstrap or Zurb Foundation. |
| - css framework like bootstrap or zurb foundation |
There are a variety of bootstrap themes like [Flat-UI](http://designmodo.com/flat-free/) |
| - css gauges http://www.larentis.eu/donuts/ |
|
| - bootstrap themes, web fonts, css sprites, icon fonts |
Check out the visualisation tools listed in the data sections for web application tools like these [CSS Dashboard gauges](http://www.larentis.eu/donuts/) |
| - http://designmodo.com/flat-free/ http://designmodo.github.com/Flat-UI/ |
|
| |
|
| ### Examples |
### Examples |
| |
|
| |
|
| ## PlanningAlerts |
#### PlanningAlerts |
| |
|
| [](img/How-to-participate-in-GovHack_html_2f0199ff1.png)Description: Planning Alerts takes data from local government development applications and sends alerts to users based on what applications are lodged in their area. |
[](img/How-to-participate-in-GovHack_html_2f0199ff1.png)Description: Planning Alerts takes data from local government development applications and sends alerts to users based on what applications are lodged in their area. |
| |
|
| Programming Language: Ruby |
Programming Language: Ruby |
| |
|
| Source Control: [Git](https://github.com/openaustralia/planningalerts-app) |
Source Control: [Git](https://github.com/openaustralia/planningalerts-app) |
| |
|
| Issue Tracking: [Atlassian JIRA](http://tickets.openaustraliafoundation.org.au/browse/PA/) |
Issue Tracking: [Atlassian JIRA](http://tickets.openaustraliafoundation.org.au/browse/PA/) |
| |
|
| ## LobbyLens |
#### LobbyLens |
| |
|
| [](img/129-Screenshot-LobbyClue_-_Chromium.png) |
[](img/129-Screenshot-LobbyClue_-_Chromium.png) |
| |
|
| Description: Displays connections between government contracts, business details, politician responsibilities, lobbyists, clients of lobbyists, political donors and the location of these entities. |
Description: Displays connections between government contracts, business details, politician responsibilities, lobbyists, clients of lobbyists, political donors and the location of these entities. |
| |
|
| Programing Language: PHP |
Programing Language: PHP |
| |
|
| Source Control: SVN (Subversion) |
Source Control: SVN (Subversion) |
| |
|
| Issue Tracking: A whiteboard |
Issue Tracking: A whiteboard |
| |
|
| ## bus.lambdacomplex.org |
#### bus.lambdacomplex.org |
| |
|
| [](img/How-to-participate-in-GovHack_html_3789acae.jpg) |
[](img/How-to-participate-in-GovHack_html_3789acae.jpg) |
| |
|
| Description: Online Canberra Bus Timetables and Trip Planner. |
Description: Online Canberra Bus Timetables and Trip Planner. |
| |
|
| Programing Language: PHP/Ruby |
Programing Language: PHP/Ruby |
| |
|
| Source Control: Git |
Source Control: Git |
| |
|
| Issue Tracking: Github |
Issue Tracking: Github |
| |
|
| ## Mobile |
## Mobile |
| |
|
| FRameworks, http://www.sencha.com/products/touch http://phonegap.com/ http://cordova.apache.org/ |
If you want to get stared quickly with mobile application development, it's worth considering cross platform frameworks like http://www.sencha.com/products/touch http://phonegap.com/ http://cordova.apache.org/ |