VanHack Platform - Backend

Build Status Dependency Status Maintainability

DEMO: https://vanhack-backend.herokuapp.com/

VanHack Domain Model

Requirements

  • Ruby 2.5.1
  • Rails 5.2.0
  • PostgreSQL 10.3

Setup

  1. Fork the respository and clone your fork
$ git clone https://github.com/<YOUR_USERNAME>/vanhack-backend
$ cd vanhack-backend
$ bundle install
  1. Setup your database
$ bin/rails db:create
$ bin/rails db:migrate
$ bin/rails db:seed

Run tests

$ bin/rspec

Use GraphiQL.app to test the API

Contributing

How To Contribute

  1. Fork the repository in GitHub
  2. Create your feature/fix branch (git checkout -b special-feature)
  3. Make sure all tests pass (bundle exec rspec)
  4. Commit your changes (git commit -am 'feature: Summarize change')
  5. Push to the branch (git push origin special-feature)
  6. Create new pull request