Skip to content

Latest commit

 

History

History
53 lines (40 loc) · 2.29 KB

README.md

File metadata and controls

53 lines (40 loc) · 2.29 KB
Raw

mdl-geo-enrichment Build Status

Description

Mashup REST API for mobility data.

This is a geographical enrichment demonstrator that Aggregates and enrich information from the following 3 sources:

Geographical demonstrator supports 3 standard data format for enrichment:

  • OSM: Open Street Map
  • GTFS: General Transit Feed Specification
  • GeoJson: Representation of geographical features based on Json

An example of API enrichment is illustrated in the bellow sequence diagram:

Sequence Diagram

Prerequisites

  • Install OpenJDK 17
  • Install Node.js
  • Install OsmToGeoJson module
  • Install GtfsToGeoJson module
$ npm install -g osmtogeojson
$ npm install -g gtfs-to-geojson

Build and Run

$ mvn install -DskipTests
$ mvn spring-boot:run

The application is also packaged as a standalone jar which can be run as follows:

$ java -jar target/mdl-geo-enrichment-0.0.1-SNAPSHOT.jar

Run as docker image

A docker image is built automatically upon main branch and pushed to docker hub with the deployed application and all prerequisites installed: openjdk11-jre & nodejs & osmtogeojson module

docker run -d -p 80:80 -p 443:443 wanam/mdl-geo-enrichment:latest --pull=always

/!\ A selfsigned certificate is used for TLS testing purposes, do not use it for production! An authority cetificate will be needed for production use.

Browse Swagger UI

Once the application is up, you can browse the apis on your local server through HTTP and HTTPS

Enriched data will be stored on a separate attribute 'enriched_properties' for each stop point on the api response.