edits
[tools.git] / index.md
Alex Sadleir 1 Welcome to the GovHack toolkit. This page provides all the information you need to prepare hackfest entries.
Maxious 2 These tools can be used to make entries like: mobile apps, web apps, data visualisations/infographics
Alex Sadleir 3
4 # How to register and submit your entry
Maxious 5 - how to use website "Hacker Space" to register and find teams etc.
Maxious 6
Alex Sadleir 7 - screencast tools - preparing your submission
8 video tools, youtube video editor/slideshow, FOSS video editing tools
Maxious 9
Alex Sadleir 10 - how to submit code
Maxious 11
Maxious 12 # General References {#general-data-hacking-and-programming-references}
Maxious 13 ## The basics of being a data scientist
Maxious 14
Maxious 15 * 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.
Maxious 16 * Find the people and tools you need to prove/show/find. This rest of this page will help with the latter.
Maxious 17 * 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.
Maxious 18 Please note, there are a combination of Analysis and Visualisation tools in each of the major categories below.
19
20
Maxious 21 [![](http://www.govhack.org/wp-content/uploads/How-to-participate-in-GovHack_html_m6a65720f-300x199.gif "Data Journalism Diagram")](http://www.govhack.org/wp-content/uploads/How-to-participate-in-GovHack_html_m6a65720f.gif)</dt>
22 Illustration from Data Journalism Handbook, CC BY-SA 3.0</dd>
maxious 23
Maxious 24
25 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
26
27 [datajournalismhandbook.org](http://datajournalismhandbook.org/)
Maxious 28
29 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
maxious 30
Maxious 31 practical advice check out Data Analysis with Open Source Tools by Philipp K. Janert
Maxious 32
33 For further reading in this space
Maxious 34
Alex Sadleir 35 [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 36
37
maxious 38 **Statistics**
Maxious 39
40 [http://greenteapress.com/thinkstats/html/index.html](http://greenteapress.com/thinkstats/html/index.html)
41
42 **Programming**
43
44 Programming is valuable skill for manipulating and displaying data.
45
46 Basic tutorials for a variety of languages are available for free online or you can learn
47
48 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/)
49
50 [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
51
52 **Accessibility/User Experience**
53
54 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/)
maxious 55
Maxious 56 ## Who can be a hack day participant
maxious 57 - roles; coder, designer UX/graphics
Maxious 58
59 ## Definitions
60 - definitions, open licence reuse permissive hacker hack data journalism data bis UCX etc.
61
62 ## key datasets
63 - key datasets, directory.gov.au gazetter/AEC electorates/suburbs/postcodes/LGAs
64
Alex Sadleir 65 ## examples
66
Maxious 67 ## The Open Budget
maxious 68
69 ## WeatherTree weather API
Maxious 70
Alex Sadleir 71 ## PlanningAlerts
Maxious 72
73 [![Planning Alerts Screenshot](http://www.govhack.org/wp-content/uploads/How-to-participate-in-GovHack_html_2f0199ff1-300x221.png "Planning Alerts Screenshot")](http://www.govhack.org/wp-content/uploads/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.
74
75 Programming Language: Ruby
76
77 Source Control: [Git](https://github.com/openaustralia/planningalerts-app)
78
79 Issue Tracking: [Atlassian JIRA](http://tickets.openaustraliafoundation.org.au/browse/PA/)
80
81 ## LobbyLens
82
83 [![](http://www.govhack.org/wp-content/uploads/129-Screenshot-LobbyClue_-_Chromium-300x180.png "LobbyLens screenshot")](http://www.govhack.org/wp-content/uploads/129-Screenshot-LobbyClue_-_Chromium.png)
84
85 Description: Displays connections between government contracts, business details, politician responsibilities, lobbyists, clients of lobbyists, political donors and the location of these entities.
86
Maxious 87 Programing Language: PHP
88
89 Source Control: SVN (Subversion)
90
91 Issue Tracking: A whiteboard
92
93 ## Bus.lambdacomplex.org
94
95 [![](http://www.govhack.org/wp-content/uploads/How-to-participate-in-GovHack_html_3789acae-300x253.jpg "Bus.lambda screenshot")](http://www.govhack.org/wp-content/uploads/How-to-participate-in-GovHack_html_3789acae.jpg)
96
97 Description: Online Canberra Bus Timetables and Trip Planner.
98
99 Programing Language: PHP/Ruby
100
101 Source Control: Git
102
103 Issue Tracking: Github
104
105
Alex Sadleir 106 ## Developer Tools For Your Computer {#developer-tools-for-your-computer}
107
108 server admin / technical tools
Maxious 109 many projects will require some kind of internet presence, webpage etc.
110 - css framework like bootstrap or zurb foundation
maxious 111 - css gauges http://www.larentis.eu/donuts/
112 - bootstrap themes, web fonts, css sprites, icon fonts
113 - http://designmodo.com/flat-free/ http://designmodo.github.com/Flat-UI/
114
115 - http://ubuntu-tutorials.com/2008/11/11/relaying-postfix-smtp-via-smtpgmailcom/
116 - amon
117
118 ### Source Control
119 Git / Subversion
120
121 [![](http://www.govhack.org/wp-content/uploads/Screenshot-at-2012-04-29-172132-300x235.png "Git Screenshot")](http://progit.org/book/)
122
123 [http://progit.org/book/](http://progit.org/book/)
124
Maxious 125 [http://svnbook.red-bean.com/](http://svnbook.red-bean.com/)
126
Maxious 127 [http://tortoisesvn.net/](http://tortoisesvn.net/)
maxious 128
Maxious 129 [http://code.google.com/p/tortoisegit/](http://code.google.com/p/tortoisegit/)
maxious 130
Maxious 131 ### Task Tracking -
maxious 132
133 Issue/task trackers allow you to outline the tasks required for your project and assign them to people to do.
Maxious 134
Maxious 135 [Trello](https://trello.com/) and [Workflowy](https://workflowy.com/) are free, lightweight project management tools suitable for a rapid project!
Alex Sadleir 136
Maxious 137 ## Hosted Developer Tools {#hosted-developer-tools}
138
Alex Sadleir 139 Can get many tools (source control, issue tracking) combined into one service cloud hosted so no setup required.
Alex Sadleir 140
141 ### Github
142 Git obviously but svn/hg interfaces are possible. Provide their own GUI for Windows/OSX or use the variety of Git capable tools
143
144 ### Sourceforge
maxious 145
146 Subversion, Git, Mercurial, Bazaar, CVS, issue tracker, wiki, release file downloads. Unlimited free use for open source projects.
147
148 You can create your own Sourceforge project at [http://sourceforge.net/](http://sourceforge.net/)
149
150 ### Google Code Project Hosting
Maxious 151
152 Git, Mercurial, and Subversion code. Issue tracker, wiki, release file downloads. Unlimited free use for open source projects.
Maxious 153
154 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/)
155
156
157
Alex Sadleir 158 # API Development {#api-development}
159
Maxious 160
161 So an API isn't just an XML file ![;)](http://www.govhack.org/wp-includes/images/smilies/icon_wink.gif)
Alex Sadleir 162
maxious 163 A good web based data API:
164
165 * Is logically organised