Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
_data
_includes
_layouts
_lib
_sass
_scraper_scripts
css
electorates
fonts
images
javascripts
postcodes
senate
.gitignore
CNAME
CODE_OF_CONDUCT.md
Gemfile
Gemfile.lock
README.md
Rakefile
_config.yml
index.html

README.md

Voting Choices

http://votingchoices.com

A simple static site that lists all known candidates for the upcoming Australian federal election on July 2nd, 2016.

Pages are generated from data in a Google spreadsheet, and anyone can submit additional data via an associated Google form.

Working on the site:

You'll need Ruby installed, and the bundler gem. Once that is the case:

bundle install

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.

Candidate Information

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/electorates.json and _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

Contributing

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:

  1. Fork it ( https://github.com/pat/my_candidates/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. 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.

Licence

Copyright (c) 2016, Voting Choices is developed and maintained by Pat Allan, and is released under the open MIT Licence.