README.md

Waterloo Region Votes

This repository is published to https://civictechwr.github.io/WRVotesMunicipal2022

It is updated for the 2022 municipal election in Waterloo Region.

Contributing

Dependencies:

• Ruby
• Bundler
• Jekyll

To get started locally:

• Clone the repo: git clone https://github.com/CivicTechWR/WRVotesMunicipal2022.git
• Install gems: bundle
• Move into the website directory: cd docs
• Start the local server: jekyll serve

Getting started on OSX

1. Install homebrew package manager
2. Install ruby:

   brew install ruby
   

3. Install bundler:

   gem install bundler
   

4. Clone the repo:

   git clone https://github.com/CivicTechWR/WRVotesMunicipal2022.git
   

5. Then go into the WRVotesMunicipal2022 directory, and run install the gems:

   cd WRVotesMunicipal2022
   bundle install
   

6. Then start the jekyll server:

   cd docs
   bundle exec jekyll server
   

7. You should now be able to follow the URL which is displayed and you should see the site. (N.B.: Some elements which are dependent upon the Github API may not be displayed locally.)

How can I help?

See the Issues list.

This project began as an initiative of CivicTechWR but as of this writing (Aug 2022) that group is dormant.