EdgarACarneiro / stfXCore

The Core infrastructure micro-service of the SpatioTemporal Features eXtractor (stfX)
MIT License
0 stars 0 forks source link

stfXCore

BCH compliance Build Status

:exclamation: This repository has been archived. Further developments on this repository are done in most-inesctec/stfXCore :exclamation:

The central microservice of the SpatioTemporal Feature eXtractor (stfX). This service, built using spring, is responsible for everything that is not the computation of spatiotemporal change features. More specifically, this service responsibilities include:

This server's updated API can be consulted here.

Section 5.2.2 of the thesis associated to the stfX contains a detailed description of this microservice architecture and general guidelines.

stfXCore packages overview

Package Description
Models CRUD interface for the data entities managed in the application. Models do not handle any business logic, solely entity self-contained logic.
Controllers Responsible for handling the stfX API endpoints and further delegate actions to the other architecture components.
Repositories Specify persistence in the database using ORM.
Services Fetch data from the Models, handle it and then provide the processed data to the Controllers. The majority of the business logic is implemented here.

The figure below illustrates how different components of the stfXCore interact to retrieve the spatiotemporal change features of interest to the end-user.

Screenshot 2020-08-01 at 16 15 43

Getting started

To run a container with the application, in a standalone manner, use:

cd stfXCore
sh docker-build.sh
docker run -p 8080:8080 stfx-core