carpark

README

carpark

An HTTP API for paying for parking.

An experiment into event sourcing backed by a Postgres database. Events are stored in serialised protobuf and state is held in memory. Also includes examples of logging, metrics and "black-box" service level specifications.

Setup

This application is written in Go and tested with Ruby and RSpec. The tests run against docker containers.

• Golang 1.10.x https://golang.org/
• Ruby 2.4.x https://www.ruby-lang.org/
• Bundler gem http://bundler.io/
• Docker https://www.docker.com/
• Protobuf 3.5.1 https://github.com/google/protobuf

Run this command to install all required Ruby gems and go tools.

$ bundle install && rake install

Available Rake tasks:

rake install     # Go get required tools
rake clean       # Remove any temporary products
rake codegen     # Generate protobuf and stringer go code
rake unittest    # Run Golang unit tests
rake build       # Build a local docker image
rake rubycodegen # Generate protobuf ruby code
rake spec        # Run RSpec code examples