Bernie-2016 / CaucusCentralAPI

API for the Caucus Central application.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Circle CI Code Climate Test Coverage

CaucusCentralAPI

Caucus Central is an app to allow caucus precinct captains to quickly and easily calculate and share their candidate's viability with a campaign headquarters.

Development

Prerequisites

  • git
  • ruby 2.3.0 (rvm recommended)
  • postgres (brew install postgres on OSX)

Setup

  1. Clone the repository (git clone git@github.com:Bernie-2016/CaucusCentralAPI.git)
  2. Install gem dependencies: bundle install
  3. Create and migrate the database: rake db:setup
  4. Create a .env file for the secret key, formatted as follows.
  5. Run rails s and clone/setup the client app
SECRET_TOKEN=some_token

Testing

  • bundle exec rspec to run tests
  • bundle exec rubocop for linting

Contributing

  1. Fork it ( https://github.com/Bernie-2016/CaucusCentralAPI/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

License

AGPL

About

API for the Caucus Central application.

License:Other


Languages

Language:Ruby 98.4%Language:HTML 1.3%Language:CSS 0.4%