Skip to content
This repository has been archived by the owner on Oct 11, 2024. It is now read-only.

Latest commit

 

History

History
77 lines (57 loc) · 3.4 KB

README.md

File metadata and controls

77 lines (57 loc) · 3.4 KB
Raw

ARCHIVED

This project is no longer maintained and will not receive any further updates. If you plan to continue using it, please be aware that future security issues will not be addressed.

Fotoquest DAO Mappings for 52n DAO SPI module

Description

Provide database customizations to provide Fotoquest data via 52n Series REST API.

This module provides custom Hibernate mappings and database views. It enables the 52n DAO SPI module to connect to a Fotoquest database. The Web application provides then RESTful data access via 52n Series REST API.

The Fotoquest module provides customizations on the default behaviour of accessing 52n series data model. Accessing Fotoquest data is therefore technically transparent for the DAO module which serves as backend access layer to retrieve data. The well defined RESTful Web interface makes it easy for lightweight clients to query and work with the data. Besides pure data access, the data can be preprocessed with common IO functionalities e.g.

  • prerendering of series data,
  • generalization,
  • overlaying of data from multiple series
  • conversion of raw data to other formats like pdf and png

The following main frameworks are used to provide this API:

Build/Install

Preparation

  1. Get Series REST API: $ git clone https://github.com/52North/series-rest-api
  2. Install Git and Maven and make it accessable from $PATH

Database

  1. If required, setup the Fotoquest Database (postgresql + postgis + fotoquest dump)
  2. Create views in the database by executing fotoquest-mappings/src/extension/fotoquest/update_views.sh (adjust user with sufficient rights beforehand)

Build Web Application

  1. $ git clone https://github.com/52North/fotoquest-series-api
  2. $ cd fotoquest-rest-api
  3. $ cp fotoquest-webapp/src/main/resources/application.properties <custom_dir>/fotoquest.properties
  4. mvn clean install -Dlocal.configFile=file:/<custom_dir>/fotoquest.properties -Denv={dev,ci,prod} (use either of these to set different log levels)
  5. Change database connection settings in <custom_dir>/fotoquest.properties
  6. Deploy fotoquest-webapp/target/fotoquest-webapp.war to ${CATALINA_HOME}/webapps/ folder
  7. Start Tomcat and access http://<server>:<port>/fotoquest-webapp/api/v1/

Further Lookups

License

The module is published under the GNU General Public License v2 (GPLv2).

Changelog

Contributing

We try to follow the GitFlow model, although we do not see it that strict.

However, make sure to do pull requests for features, hotfixes, etc. by making use of GitFlow. Altlassian provides [a good overview] (https://www.atlassian.com/de/git/workflows#!workflow-gitflow). of the most common workflows.

Contact

Henning Bredel (h.bredel@52north.org)