Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/pat/my_candidates

Last synced: 5 days ago
JSON representation

Host: GitHub
URL: https://github.com/pat/my_candidates
Owner: pat
Created: 2016-05-04T11:56:15.000Z (over 8 years ago)
Default Branch: gh-pages
Last Pushed: 2024-10-29T00:21:46.000Z (about 2 months ago)
Last Synced: 2024-11-07T03:55:48.479Z (about 2 months ago)
Language: HTML
Homepage: http://votingchoices.com
Size: 998 KB
Stars: 0
Watchers: 3
Forks: 4
Open Issues: 2
Metadata Files:
- Readme: README.md
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

# Voting Choices

[http://votingchoices.com](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](https://docs.google.com/spreadsheets/d/1PaS7lYTs5pAccFIHImzfStKVFdetjGHuHz54DoOdBP4/edit?usp=sharing), and anyone can submit additional data via [an associated Google form](https://docs.google.com/forms/d/1mpS6fpwPAQGciaydUn-l_YyCEosYic3PHbdJf6Cz8gc/viewform).

## 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