A simple static site that lists all known candidates for the upcoming Australian federal election on July 2nd, 2016.
Working on the site:
You'll need Ruby installed, and the bundler gem. Once that is the case:
To run a webserver that hosts the site locally:
bundle exec jekyll serve
Scrapers and Data
Unless there are data changes, you won't need to run any of these tasks - all data and template files are committed to the repository.
To regenerate the popolo data from the Google spreadsheet, use the
generate:popolo rake task:
bundle exec rake generate:popolo
To rebuild the electorate and postcode pages from the latest popolo data, use the
generate:pages rake task:
bundle exec rake generate:pages
And to run them both together (which will be needed every time the Google spreadsheet has updated information), there's a single
generate:all rake task:
bundle exec rake generate:all
Postcodes, Electorates, Parties
Postcode, electorate and party information has been scraped from the AEC website in
_data/parties.json. You shouldn't need to recreate these files from scratch (there's nothing volatile about this data), but on the off chance it is needed, run the following rake tasks:
bundle exec rake scrapers:electorates bundle exec rake scrapers:parties
Firstly, please note the Code of Conduct for all contributions to this project. If you accept that, then the steps for contributing are probably something along the lines of:
- Fork it ( https://github.com/pat/my_candidates/fork )
- Create your feature branch (
git checkout -b my-new-feature)
- Commit your changes (
git commit -am 'Add some feature')
- Push to the branch (
git push origin my-new-feature)
- Create a new Pull Request
Also: for any sizable features/changes, it's probably worth opening up an issue to discuss things first. This hopefully avoids duplication of efforts, or working on things that won't be merged in.
Copyright (c) 2016, Voting Choices is developed and maintained by Pat Allan, and is released under the open MIT Licence.