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