Skip to content
This repository has been archived by the owner on Dec 30, 2022. It is now read-only.

Latest commit

 

History

History
62 lines (40 loc) · 1.78 KB

README.md

File metadata and controls

62 lines (40 loc) · 1.78 KB
Raw

Geolocation Microservice in Flamingo (www.flamingo.me)

Simple Geolocationing Microservice in Flamingo with a base set of providers (prone to changes, currently IpData, IpInfo, IPSTack und Maxmind)

Getting Started

  • Install Go
  • Obtain API Key from the respective provider and edit the config/config.yml accordingly. Don't forget to deactivate unwanted providers there or you will get errors. The result will be a collection of active provider responses.
  • fire up go run main.go serve or make serve
  • Its running, should be reachable at http://localhost:3322/geolocation/[insert IP Address here]

Prerequisites

You will need Golang in version 1.12.1 installed.

Configuration

The config/config.yml contains a provider configuration with api key and url (provider specific), which could grow by supported providers in the future. New Providers have to implement the LocationProvider interface to work.

Test Pipeline

Test Pipeline

Running the tests

Use the following to run the tests:

go test ./... -v

or use the make target

make test

Building the Binary

Also, use a make target :-)

make build

or, if you need a linux amd64 binary, use

make build-linux

Built With

  • Flamingo - Scalable frontend framework for your headless microservice architecture

Authors

  • Jens Sadowski - Initial work - resubaka
  • Julien Wiedner - Initial work - juce93
  • Joachim Adomeit - Initial work - jadhub

License

This project is licensed under the Open Software License v. 3.0 (OSL-3.0) - see the LICENSE file for details