editz
[tools.git] / index.md
Maxious 1 #GovHack Toolkit
2 Welcome to the GovHack toolkit. This page provides all the information you need to prepare hackfest entries.
3 These tools can be used to make entries like mobile apps, web apps and data visualisations/infographics.
4
5 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
6
7 # How to register and submit your entry
maxious 8 ## Registering your team
Maxious 9 Coming Soon: how to use the website "Hacker Space" to register and find teams.
maxious 10
Maxious 11 ## Preparing your submission
12
13 You should record a 3 minute speech and mix images/text to accompany.
14 http://www.screenr.com/ and other screencasting tools allow you to demo apps.
15 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/
16
17 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.
maxious 18 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.
Maxious 19
20
21 # General References {#general-data-hacking-and-programming-references}
22
23 ## Who can be a hack day participant
24 There are many roles you can play as a hack day participant; coder, designer UX/graphics.
25
26 ## The basics of being a data scientist
27
28 * 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.
29 * Find the people and tools you need to prove/show/find. This rest of this page will help with the latter.
30 * Analyse and present results - were they what you expected? Do they help explain to others what you have found out?
31 Can present as a interactive data visualisation or a web/mobile application or just a infographic/motion graphics video that tells a story.
32
33 [![](img/How-to-participate-in-GovHack_html_m6a65720f-300x199.gif "Data Journalism Diagram")](img/How-to-participate-in-GovHack_html_m6a65720f.gif)</dt>
34 Illustration from Data Journalism Handbook, CC BY-SA 3.0</dd>
35
36 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
37 [datajournalismhandbook.org](http://datajournalismhandbook.org/)
38
39 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
40 practical advice check out Data Analysis with Open Source Tools by Philipp K. Janert
maxious 41 For further reading in this space
Maxious 42 [http://flowingdata.com/2012/04/27/data-and-visualization-blogs-worth-following/](http://flowingdata.com/2012/04/27/data-and-visualization-blogs-worth-following/)
maxious 43
Maxious 44
45 **Statistics**
46
47 A great guide to statistics is
48 [Think Stats](http://greenteapress.com/thinkstats/html/index.html)
49
50 **Programming**
51
52 Programming is valuable skill for manipulating and displaying data.
53 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/)
54
55 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)
56
57 **Accessibility/User Experience**
58
59 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/)
60
61
62
63 # Developer Tools For Your Computer {#developer-tools-for-your-computer}
64 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.
65
66 ### Source Control
67 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!
68
69 [![](img/Screenshot-at-2012-04-29-172132-300x235.png "Git Screenshot")](http://progit.org/book/)
70
71 [http://progit.org/book/](http://progit.org/book/)
72
73 [http://svnbook.red-bean.com/](http://svnbook.red-bean.com/)
74
75 [http://tortoisesvn.net/](http://tortoisesvn.net/)
76
77 [http://code.google.com/p/tortoisegit/](http://code.google.com/p/tortoisegit/)
78
79 ### Task Tracking
80
81 Issue/task trackers allow you to outline the tasks required for your project and assign them to people to do.
82
83 [Trello](https://trello.com/) and [Workflowy](https://workflowy.com/) are free, lightweight project management tools suitable for a rapid project!
84
85 ## Hosted Developer Tools {#hosted-developer-tools}
86
87 Can get many tools (source control, issue tracking) combined into one service cloud hosted so there's no setup required.
88
89 ### Github
90 Git obviously but svn/hg interfaces are also available. Provide their own GUI for Windows/OSX or use a variety of Git capable tools
91
92 ### Sourceforge
93
94 Subversion, Git, Mercurial, Bazaar, CVS, issue tracker, wiki, release file downloads. Unlimited free use for open source projects.
95
96 You can create your own Sourceforge project at [http://sourceforge.net/](http://sourceforge.net/)
97
98 ### Google Code Project Hosting
99
100 Git, Mercurial, and Subversion code. Issue tracker, wiki, release file downloads. Unlimited free use for open source projects.
101
102 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/)
103
104
105 # Applications of data hacking
106
107 ## API Development {#api-development}
maxious 108
109
Maxious 110 So an API isn't just an XML file ![;)](http://www.govhack.org/wp-includes/images/smilies/icon_wink.gif)
111
112 A good web based data API:
113
114 * Is logically organised
115 * Can filter returned data
116 * Can return results in different open formats (CSV/JSON etc.)
117 * Is efficient and responsive by using caching and databases appropriately
118 * Handles errors gracefully
119 * Monitors and controls access (to show benefit realised of API and prevent abuse)
120 * Provides appropriate documentation with examples
121
122 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.
123
124 Atlassian have a great page on what makes a good API https://developer.atlassian.com/display/REST/Atlassian+REST+API+Design+Guidelines+version+1)
125
126 HowTo.gov has a bunch of api resources about choosing SOAP vs. REST etc. http://www.howto.gov/mobile/apis-in-government
Maxious 127
128 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)
129 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
130 Or for Ruby on Rails there is is https://github.com/elc/rapi_doc https://github.com/Pajk/apipie-rails
131
132 better apis https://github.com/liip/LiipHelloBundle
133
134 http://amberonrails.com/building-stripes-api/
135
136 example WeatherTree weather API
137
138
139 ## Infographics and Data Visualisation {#data-visualisation}
140
141 Infographics try to contextualise charts and graphs to tell a story. Data vis builds on this to find new ways to design insight.
142
143 Most of the categories to follow have visualisation tools specific to their purpose.
144
145 You can find some data visualisation tools below:
146
147 [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/)
Alex Sadleir 148
Maxious 149 Also check out [http://thejit.org](http://thejit.org/) &amp; [http://www.senchalabs.org/<wbr>philogl/</wbr>](http://www.senchalabs.org/philogl/) (contributed by Matt Adcock)
150
maxious 151 Have to use visual art concepts, good color schemes http://www.r-bloggers.com/the-paul-tol-21-color-salute/
152
153
154 - https://graphics.stanford.edu/wikis/cs448b-12-fall/ data viz theory
155 - http://drawingbynumbers.org/toolsandresources
156 - http://selection.datavisualization.ch/ data viz tools catalog
157
158 examples - http://sunfoundation.tumblr.com/
159 ### The Open Budget
160
161
162 ## Web Applications
163
164 With the rise of HTML5 technologies it is easier than ever to make a web application for engaging use of data.
165
166 - css framework like bootstrap or zurb foundation
Maxious 167 - css gauges http://www.larentis.eu/donuts/
168 - bootstrap themes, web fonts, css sprites, icon fonts
169 - http://designmodo.com/flat-free/ http://designmodo.github.com/Flat-UI/
170
171 ### Examples
172
173
174 #### PlanningAlerts
175
Maxious 176 [![Planning Alerts Screenshot](img/How-to-participate-in-GovHack_html_2f0199ff1-300x221.png "Planning Alerts Screenshot")](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.
Maxious 177
178 Programming Language: Ruby
Alex Sadleir 179
180 Source Control: [Git](https://github.com/openaustralia/planningalerts-app)
181
182 Issue Tracking: [Atlassian JIRA](http://tickets.openaustraliafoundation.org.au/browse/PA/)
183
184 #### LobbyLens
maxious 185
186 [![](img/129-Screenshot-LobbyClue_-_Chromium-300x180.png "LobbyLens screenshot")](img/129-Screenshot-LobbyClue_-_Chromium.png)
187
188 Description: Displays connections between government contracts, business details, politician responsibilities, lobbyists, clients of lobbyists, political donors and the location of these entities.
189
190 Programing Language: PHP
Maxious 191
192 Source Control: SVN (Subversion)
Maxious