Theodolite
==========

 ![](https://upload.wikimedia.org/wikipedia/commons/3/30/SovietTheodolite.jpg)

This repository is about Open Addresses' publishing APIs software component. It is named "theodolite", after [the precision instrument for measuring angles in the horizontal and vertical planes, used mainly for surveying applications](http://en.wikipedia.org/wiki/Theodolite). Theodolite is part of the solution Open Addresses deployed for the Alpha stage of our services. Read about Theodolite [here](http://alpha.openaddressesuk.org/docs) or learn about Open Addresses in general [here](http://alpha.openaddressesuk.org).

## Dependencies

As well as Ruby version 2.1.3, you'll also need MongoDB installed. [See installation instructions](http://docs.mongodb.org/manual/installation/).

## Running

### Clone the repo:

`git clone git@github.com:OpenAddressesUK/theodolite.git`

### Bundle:

`bundle install`

### Run the server

`rails s`

### Get some addresses

Follow the instructions in [Distiller](https://github.com/OpenAddressesUK/distiller/blob/master/README.md) to find out how to import addresses for use in the app.

##Licence
The theodolite picture is sourced from [Wikimedia Commons](http://commons.wikimedia.org/wiki/File:SovietTheodolite.jpg). The code is open source under the MIT license. See the LICENSE.md file for full details.