| |
#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, data visualisations/infographics. |
| |
This toolkit is open source, licenced cc-by and improvements are encouraged ... |
| |
|
| # How to register and submit your entry |
# How to register and submit your entry |
| ## registering your team |
## Registering your team |
| TODO how to use website "Hacker Space" to register and find teams etc. |
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. |
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/ |
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 {#general-data-hacking-and-programming-references} |
| |
|
| ## Who can be a hack day participant |
## Who can be a hack day participant |
| - roles; coder, designer UX/graphics |
- roles; coder, designer UX/graphics |
| |
|
| ## Definitions |
## Definitions |
| - definitions, open licence reuse permissive hacker hack data journalism data vis UX etc. |
- 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> |
| [](http://www.govhack.org/wp-content/uploads/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) |
[http://greenteapress.com/thinkstats/html/index.html](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 [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/) |
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/) |
| |
|
| [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 |
[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/) |
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/) |
| |
|
| |
|
| |
|
| ## examples |
# 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. |
| ## The Open Budget |
|
| |
|
| ## WeatherTree weather API |
|
| |
|
| ## PlanningAlerts |
|
| |
|
| [](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. |
|
| |
|
| Programming Language: Ruby |
|
| |
|
| Source Control: [Git](https://github.com/openaustralia/planningalerts-app) |
|
| |
|
| Issue Tracking: [Atlassian JIRA](http://tickets.openaustraliafoundation.org.au/browse/PA/) |
|
| |
|
| ## LobbyLens |
|
| |
|
| [](http://www.govhack.org/wp-content/uploads/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. |
|
| |
|
| Programing Language: PHP |
|
| |
|
| Source Control: SVN (Subversion) |
|
| |
|
| Issue Tracking: A whiteboard |
|
| |
|
| ## bus.lambdacomplex.org |
|
| |
|
| [](http://www.govhack.org/wp-content/uploads/How-to-participate-in-GovHack_html_3789acae.jpg) |
|
| |
|
| Description: Online Canberra Bus Timetables and Trip Planner. |
|
| |
|
| Programing Language: PHP/Ruby |
|
| |
|
| Source Control: Git |
|
| |
|
| Issue Tracking: Github |
|
| |
|
| |
|
| ## Developer Tools For Your Computer {#developer-tools-for-your-computer} |
|
| |
|
| server admin / technical tools |
|
| many projects will require some kind of internet presence, webpage etc. |
|
| - css framework like bootstrap or zurb foundation |
|
| - css gauges http://www.larentis.eu/donuts/ |
|
| - bootstrap themes, web fonts, css sprites, icon fonts |
|
| - http://designmodo.com/flat-free/ http://designmodo.github.com/Flat-UI/ |
|
| |
|
| - http://ubuntu-tutorials.com/2008/11/11/relaying-postfix-smtp-via-smtpgmailcom/ |
|
| - amon |
|
| |
|
| ### Source Control |
### Source Control |
| Git / Subversion |
Git / Subversion |
