api

Package api provides the structure api.Api which coordinates the routes, middleware and services of the Elos API.

Getting Started

The API comes with a preconfigured Vagrant VirtualBox. Therefore you can develop on the API locally using your own go workspace, or you can start the vagrant-managed virtual machine and develop in a production-like environment. We use the vagrant box (an Ubuntu 14.04 machine) to build the API for our production environment (which is also Ubuntu 14.04). We recommend you develop using Vagrant.

Developing with Vagrant

    # Need the repo
    git clone https://github.com/elos/api

    # Start the vagrant box
    vagrant up

    # Now we can ssh in
    vagrant ssh

    # Once inside, cd into the preconfigured workspace
    vagrant:$~ cd $GOPATH

You need

1. Vagrant
2. VirtualBox

Developing Locally

    go get github.com/elos/api

Run the Tests

    go test