richeterre / goalbase

Simple Rails + Grape API for storing player and match data

Goalbase

Goalbase serves as a backend for the reactive MVVM showcase apps SwiftGoal and ObjectiveGoal.

It is built using the Grape API framework, mounted on a vanilla Rails 4 installation.

Setup

Clone the project and run

bundle install

in the project's root folder. To set up the database, make sure you have a running PostgreSQL instance. A quick way is to install Heroku's Postgres.app. Then by running

rake db:setup

all necessary tables should get created. Finally, start the app using

rails server

and check that it works by hitting the API endpoints:

http://localhost:3000/api/v1/players
http://localhost:3000/api/v1/matches

Both should display an empty JSON array, as you don't have any data yet. To change that, clone SwiftGoal and launch it on your iOS simulator. Make sure that the base URL http://localhost:3000/api/v1/ is set up correctly in the app's settings.

License

This project is available under the MIT license.