Tvarkau Vilnių backend

API for Tvarkau Vilnių apps. Manages problems reported by Vilnius citizens.

API specification

Getting started

Setting up development environment

Option 1: vagrant

This automatically creates and provisions ubuntu 16.04 based box with needed dev tools. Tested on: OSX Sierra and Windows 10.

Pre-requisites:

• Vagrant
• VirtualBox 5.1.14

(Note: at the moment of writing, latest (5.1.16) has a regression issue)

$ vagrant plugin install vagrant-vbguest
$ vagrant up

Login into the dev box:

$ vagrant ssh

Option 2: native (OSX)

• Install docker
• Install docker-compose
• Install Homebrew
• Install rbenv
• Install ruby 2.4.3

Running app

Using docker:

$ docker-compose up

Or manually:

• gem install bundler
• Run DB docker-compose up -d db
• bundle install
• Ensure database migrations are up to date
  • If this is your first run: rake db:setup, rake db:seed
  • Every other time rake db:migrate
• Start server using rails s

Open http://localhost:3000/api/reports to get latest reports

Running tests

• bundle exec rspec spec or make test

Related projects:

• Android: https://github.com/vilnius/tvarkau-vilniu
• iOS: https://github.com/vilnius/tvarkau-vilniu-ios

Contribute

• Join us on Slack #tvarkau-vilniu! For an automated invitation click the big Slack button at http://codeforvilnius.lt
• Feel free to create pull requests or issues
• Contribution guide coming soon
• Check out for more at http://codeforvilnius.lt/

Note: This is a work in-progress