| Below is a whole bunch of information to help you prepare mashups! | #GovHack Toolkit |
| Welcome to the GovHack toolkit. This page provides all the information you need to prepare hackfest entries. | |
| # [Hosted Developer Tools](#hosted-developer-tools) | These tools can be used to make entries like mobile apps, web apps and data visualisations/infographics. |
| 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 | |
| ## Registering your team | |
| Coming Soon: how to use the website "Hacker Space" to register and find teams. | |
| ## Preparing your submission | |
| 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. | |
| 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. | |
| 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} | |
| ## Who can be a hack day participant | |
| There are many roles you can play as a hack day participant; coder, designer UX/graphics. | |
| ## 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. | |
| * 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? | |
| 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> | |
| 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 | |
| [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 | |
| practical advice check out Data Analysis with Open Source Tools by Philipp K. Janert | |
| 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/) | |
| **Statistics** | |
| A great guide to statistics is | |
| [Think Stats](http://greenteapress.com/thinkstats/html/index.html) | |
| **Programming** | |
| 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 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/) | |
| 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) | |
| **Accessibility/User Experience** | |
| 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} | |
| 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 | |
| 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://svnbook.red-bean.com/](http://svnbook.red-bean.com/) | |
| [http://tortoisesvn.net/](http://tortoisesvn.net/) | |
| [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. | |
| [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} | |
| Can get many tools (source control, issue tracking) combined into one service cloud hosted so there's no setup required. | |
| ### Github | |
| Git obviously but svn/hg interfaces are also available. Provide their own GUI for Windows/OSX or use a variety of Git capable tools | |
| ### 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 | |
| # The basics of being a data scientist | |
| ## API Development {#api-development} | |
| * Find the people and tools you need to prove/show/find. This rest of this page will help with the latter. | |
| So an API isn't just an XML file  | |
| Please note, there are a combination of Analysis and Visualisation tools in each of the major categories below. | |
| # [API Development](#api-development) | |
| 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](https://developer.atlassian.com/display/REST/Atlassian+REST+API+Design+Guidelines+version+1)[://](https://developer.atlassian.com/display/REST/Atlassian+REST+API+Design+Guidelines+version+1)[developer.atlassian.<wbr>com</wbr>](https://developer.atlassian.com/display/REST/Atlassian+REST+API+Design+Guidelines+version+1)[/display/REST/](https://developer.atlassian.com/display/REST/Atlassian+REST+API+Design+Guidelines+version+1)[Atlassian](https://developer.atlassian.com/display/REST/Atlassian+REST+API+Design+Guidelines+version+1)[+<wbr>REST+API+Design+Guidelines+<wbr>version+1</wbr></wbr>](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) |
| HowTo.gov has a bunch of api resources about choosing SOAP vs. REST etc. http://www.howto.gov/mobile/apis-in-government | |
| 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) | |
| 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 | |
| # [Data Visualisation](#data-visualisation) | |
| better apis https://github.com/liip/LiipHelloBundle | |
| - or for Rails https://github.com/elc/rapi_doc https://github.com/Pajk/apipie-rails | |
| http://amberonrails.com/building-stripes-api/ | |
| example WeatherTree weather API | |
| ## 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. | |
| 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 “essential”\. 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/) | [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/) |
| 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/ | |
| # [Augmented Reality Tools](#augmented-reality-tools) | |
| - https://graphics.stanford.edu/wikis/cs448b-12-fall/ data viz theory | |
| ### buildAR | - http://drawingbynumbers.org/toolsandresources |
| buildAR was the world’s first AR Content Management System with the first early version launched back in 200\. as a bit of a test to see if people were interested in being able to create their own augmented experiences. MOB Labs officially launched the new improved buildAR at the Augmented Reality event in Silicon Valley in May 2011. | examples - http://sunfoundation.tumblr.com/ |
| ### The Open Budget | |
| [http://buildAR.com](http://buildar.com/) (normally a 1\. day free trial but GovHack attendees on the day will get a fully activated account for a month. If you are a GovHack attendee want full access now to play, just sign up for a trial and then forward your GovHack Eventbrite registration email to govhack [at] buildar.com and they’ll set you up for the free month fully activated account within a couple of days. | |
| tools - http://selection.datavisualization.ch/ data viz tools catalog | |
| ### Other AR tools and references | |
| ## Web Applications | |
| theAWEsomeWEB –\. Future of the Augmented Web [http://theAWEsomeWEB.com](http://theawesomeweb.com/) | |
| With the rise of HTML5 technologies it is easier than ever to make a web application for engaging use of data. | |
| Layar –\. AR Browser - [http://layar.com](http://layar.com/) | |
| - css framework like bootstrap or zurb foundation | |
| Junaio –\. AR Browser - [http://junaio.com](http://junaio.com/) | - css gauges http://www.larentis.eu/donuts/ |
| - bootstrap themes, web fonts, css sprites, icon fonts | |
| Aurasma –\. AR Browser - [http://aurasma.com/](http://aurasma.com/) | - http://designmodo.com/flat-free/ http://designmodo.github.com/Flat-UI/ |
| Vuforia –\. NFT based AR SDK - [http://qualcomm.com/solutions/<wbr>augmented-reality</wbr>](http://qualcomm.com/solutions/augmented-reality) | ### Examples |
| String –\. Marker based AR SDK - [http://poweredbystring.com/](http://poweredbystring.com/) | |
| #### PlanningAlerts | |
| [pointcloud.io](http://pointcloud.io/) - SLAM based AR SDK - [http://pointcloud.io/](http://pointcloud.io/) | |
| [](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. | |
| ARToolkit –\. Marker based AR SDK - [http://en.wikipedia.org/wiki/<wbr>ARToolKit</wbr>](http://en.wikipedia.org/wiki/ARToolKit) | |
| Programming Language: Ruby | |
| FLARToolkit –\. Marker based AR SDK - [http://saqoo.sh/a/en/<wbr>flartoolkit/start-up-guide</wbr>](http://saqoo.sh/a/en/flartoolkit/start-up-guide) | |
| Source Control: [Git](https://github.com/openaustralia/planningalerts-app) | |
| Kooaba –\. Visual search platform - [http://kooaba.com](http://kooaba.com/) | |
| Issue Tracking: [Atlassian JIRA](http://tickets.openaustraliafoundation.org.au/browse/PA/) | |
| Catchoom –\. Visual search platform - [http://catchoom.com/](http://catchoom.com/) | |
| #### LobbyLens | |
| Google Googles –\. Visual search app - [http://www.google.com/mobile/<wbr>goggles/#text</wbr>](http://www.google.com/mobile/goggles/#text) | |
| [](img/129-Screenshot-LobbyClue_-_Chromium.png) | |
| Vuzix 920AR –\. Wearable display - [http://www.vuzix.com/consumer/<wbr>products_wrap920ar.html</wbr>](http://www.vuzix.com/consumer/products_wrap920ar.html) | |
| Description: Displays connections between government contracts, business details, politician responsibilities, lobbyists, clients of lobbyists, political donors and the location of these entities. | |
| Project Glass –\. Googles wearable display project - [http://www.youtube.com/watch?<wbr>v=9c6W4CCU9M4</wbr>](http://www.youtube.com/watch?v=9c6W4CCU9M4) | |
| Programing Language: PHP | |
| Mixed Reality –\. Nokia’s vision for wearable displays [http://www.youtube.com/watch?<wbr>v=CGwvZWyLiBU</wbr>](http://www.youtube.com/watch?v=CGwvZWyLiBU) | |
| Source Control: SVN (Subversion) | |
| City Lens –\. Nokia’s latest AR app - [http://www.youtube.com/watch?<wbr>v=63lNPkl-EPE&feature=youtu.be</wbr>](http://www.youtube.com/watch?v=63lNPkl-EPE&feature=youtu.be) | |
| Issue Tracking: A whiteboard | |
| AR –\. Wikipedia page - [http://en.wikipedia.org/wiki/<wbr>Augmented_reality</wbr>](http://en.wikipedia.org/wiki/Augmented_reality) | |
| #### bus.lambdacomplex.org | |
| Steve Mann –\. Wearable Computing Pioneer - [http://en.wikipedia.org/wiki/<wbr>Steve_Mann</wbr>](http://en.wikipedia.org/wiki/Steve_Mann) | |
| [](img/How-to-participate-in-GovHack_html_3789acae.jpg) | |
| Thad Starner –\. Wearable Computing Pioneer [http://en.wikipedia.org/wiki/<wbr>Thad_Starner</wbr>](http://en.wikipedia.org/wiki/Thad_Starner) | |
| Description: Online Canberra Bus Timetables and Trip Planner. | |
| Mark Weiser –\. Father of Pervasive Computing [http://en.wikipedia.org/wiki/<wbr>Mark_Weiser</wbr>](http://en.wikipedia.org/wiki/Mark_Weiser) | |
| Programing Language: PHP/Ruby | |
| Geographical Data Tools](#geographical-data-tools) | |
| Source Control: Git | |
| Check out the[ GeoRabble Boundary Mapper’s Cookbook](http://georabble.org/2012/05/31/the-boundary-mappers-cookbook/) to see how you can tie all these things together! | |
| Issue Tracking: Github | |
| ## Mobile | |
| Frameworks, http://www.sencha.com/products/touch http://phonegap.com/ http://cordova.apache.org/ | |
| html5 jquery mobile like directory.gov.au | |
| For data visualisation, there are a variety of graph widgets http://code.google.com/p/afreechart/ http://code.google.com/p/snowdon/ http://code.google.com/p/chartdroid/ http://androidplot.com/ http://code.google.com/p/achartengine/ | |
| Backend frameworks http://helios.io/ https://www.parse.com/ | |
| ### Examples | |
| bom water, | |
| nz gov budget | |
| # Geographical Data Tools {#geographical-data-tools} | |
| Check out the[ GeoRabble Boundary Mapper's Cookbook](http://georabble.org/2012/05/31/the-boundary-mappers-cookbook/) to see how you can tie all these things together! | |
| ## Key datasets | |
| - base layers like agri http://agri.openstreetmap.org/, http://irs.gis-lab.info/ wms or http://www.gdal.org/frmt_wms_openstreetmap_tms.xml | |
| ASGS including suburbs/postcodes | |
| - andrewharvey4.wordpress.com postgis/asgs tutorial | |
| ## Wrangling | |
| ### Converting | |
| There are many spatial data formats and often the one your tool requires is not the one the dataset is provided in | |
| Online | |
| - http://converter.mygeodata.eu/vector kml exporter for shp | |
| or locally using GDAL | |
| ### Geocoding | |
| cloudmade, google (but you must display on a Google Map). | |
| Easiest way to do is with a Google Spreadsheet/Fusion Table http://williamparry.blogspot.com.au/2011/04/putting-data-into-google-fusion-tables.htm http://support.google.com/fusiontables/answer/1012281?hl=en&ref_topic=2592806 | |
| ## Analysis | ## Analysis |
| ### PostGIS | ### PostGIS |
| [](http://www.govhack.org/wp-content/uploads/postgisexample.jpg)PostGIS is an extension for the PostgreSQL database server that allows you to store and manipulate geospatial data on a large scale. For example finding which points are in an area or what points are closest . It is also very useful for storing geospatial data because it can convert between all major formats including ESRI Shape files and Google Earth/Maps KML. | [](img/postgisexample.jpg)PostGIS is an extension for the PostgreSQL database server that allows you to store and manipulate geospatial data on a large scale. For example finding which points are in an area or what points are closest . It is also very useful for storing geospatial data because it can convert between all major formats including ESRI Shape files and Google Earth/Maps KML. |
| ### Quantum GIS | ### Quantum GIS |
| [](http://www.govhack.org/wp-content/uploads/How-to-participate-in-GovHack_html_m50afbe88.jpg)QGIS is a graphical desktop application that allows viewing and editing of geospatial data. Some good base maps are available by adding the WMS layer/server [http://irs.gis-lab.info/](http://irs.gis-lab.info/) | [](img/How-to-participate-in-GovHack_html_m50afbe88.jpg)QGIS is a graphical desktop application that allows viewing and editing of geospatial data. Some good base maps are available by adding the WMS layer/server [http://irs.gis-lab.info/](http://irs.gis-lab.info/) |
| ## Visualisation | ## Visualisation |
| ### Layar and other augmented reality tools | |
| ### Google Fusion Tables/ChartsBin/[OpenHeatMap](http://www.openheatmap.com/) | ### Google Fusion Tables/ChartsBin/[OpenHeatMap](http://www.openheatmap.com/) |
| [](http://www.govhack.org/wp-content/uploads/fusiontablesscreenshot.jpg)Input a numerical values and areas to a spreadsheet and maps are produced | [](img/fusiontablesscreenshot.jpg)Input numerical values and areas to a spreadsheet and maps are produced where the areas are colored on a scale of the values |
| http://www.peteraldhous.com/CAR/Making_maps_with_Google_Fusion_Tables.pdf tutorial or http://support.google.com/fusiontables/topic/2592754?hl=en&ref_topic=27020 for google help files | |
| ### [Cartographer.js](http://cartographer.visualmotive.com/) | ### [Cartographer.js](http://cartographer.visualmotive.com/) |
| [](http://www.govhack.org/wp-content/uploads/cartographerjs.png)Input data as JSON and maps are produced. | [](img/cartographerjs.png)Input data as JSON and maps are produced. |
| See also d3 maps. | |
| - http://bost.ocks.org/mike/map/ | |
| ### OpenLayers/Google Maps/[Leaflet](http://leaflet.cloudmade.com/) | ### OpenLayers/Google Maps/[Leaflet](http://leaflet.cloudmade.com/) |
| [](http://www.govhack.org/wp-content/uploads/How-to-participate-in-GovHack_html_512fcbe1.jpg)Display points and different layers. Leaflet is the easiest to use if you just want to show points with popups when clicked on. | [](img/How-to-participate-in-GovHack_html_512fcbe1.jpg)Display points and different layers. Leaflet is the easiest to use if you just want to show points with popups when clicked on. |
| There are wrappers for Google maps like http://hpneo.github.com/gmaps/examples.html and Mapstraction that can make it easier to use too. | |
| ### NASA World Wind/Google Earth | ### NASA World Wind/Google Earth |
| [](http://www.govhack.org/wp-content/uploads/How-to-participate-in-GovHack_html_4dda24a4.jpg)Google Earth provides 3\. viewing of KML/GML files which represent points and shapes, both through a desktop application and a web plugin. These can be extended with interactive features that allow you to view by timeline or have animated tours between different points. You can also develop and customise your own viewer with the open source [NASA World Wind toolkit.](http://goworldwind.org/demos/) | [](img/How-to-participate-in-GovHack_html_4dda24a4.jpg)Google Earth provides 3\. viewing of KML/GML files which represent points and shapes, both through a desktop application and a web plugin. These can be extended with interactive features that allow you to view by timeline or have animated tours between different points. You can also develop and customise your own viewer with the open source [NASA World Wind toolkit.](http://goworldwind.org/demos/) |
| ### | ### |
| Tabular D |