https://github.com/akhenakh/regionagogo

A worldwide regions or fences database, give it coordinates it answers back with informations for the fence like country and state
https://github.com/akhenakh/regionagogo

Last synced: 11 days ago
JSON representation

A worldwide regions or fences database, give it coordinates it answers back with informations for the fence like country and state

• Host: GitHub
• URL: https://github.com/akhenakh/regionagogo
• Owner: akhenakh
• License: mit
• Created: 2016-02-26T00:10:26.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2018-02-13T14:49:12.000Z (over 6 years ago)
• Last Synced: 2024-10-16T03:43:09.822Z (23 days ago)
• Language: Go
• Homepage:
• Size: 39.7 MB
• Stars: 75
• Watchers: 10
• Forks: 16
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![wercker status](https://app.wercker.com/status/82617ea8fffe1b93a6956c7ba5559365/s/master "wercker status")](https://app.wercker.com/project/byKey/82617ea8fffe1b93a6956c7ba5559365) [![Go Report Card](https://goreportcard.com/badge/github.com/akhenakh/regionagogo)](https://goreportcard.com/report/github.com/akhenakh/regionagogo)  [![GoDoc](https://godoc.org/github.com/akhenakh/regionagogo?status.svg)](https://godoc.org/github.com/akhenakh/regionagogo)

Region à gogo is a microservice, it's a simple database that returns metadata associated to a fence for a given location.

It uses S2 and a segment tree to create a fast geo shape database, details of implementation are described in this [blog post](http://blog.nobugware.com/post/2016/geo_db_s2_region_polygon).

It can also be used directly from docker `docker run -P akhenakh/regionagogo`

## Data

You can use any geo data but the provided GeoJSON comes from [who's on first](https://whosonfirst.mapzen.com).

It works too with [Gadm Data](http://gadm.org/version2) but the data are not free for commercial use.    

Regionagogo is using a BoltDB datafile to store the fences and a small segment tree as index lives in memory.  

## Build & Install

```

go get github.com/akhenakh/regionagogo

cd $GOPATH/src/github.com/akhenakh/regionagogo

make

```

To generate the database from GeoJSON use the provided `ragogenfromjson` command, you can specify the fields you want from the GeoJSON properties to be saved into the DB:

```

ragogenfromjson -filename testdata/world_region.geojson -importFields iso -dbpath ./region.db

```

## Usage

Run `regionagogo -dbpath ./region.db`, it will listen on port `8082`.

You can query via HTTP GET:

```

GET /query?lat=19.542915&lng=-155.665857

{

    "code": "US",

    "name": "Hawaii"

}

```

## Using it as a library

You can use it in your own code without the HTTP interface:  

```

gs := regionagogo.NewGeoSearch("region.db")

r := gs.StabbingQuery(msg.Latitude, msg.Longitude)

```

## TODO

- create a struct for data import, change the default coverer ...

- move the cache outside of boltdb storage to make it generic 

- implement an in memory storage