npm.io
29.0.0-rc1 • Published yesterday

arlas-api

Licence
Apache-2.0
Version
29.0.0-rc1
Deps
2
Size
1.3 MB
Vulns
0
Weekly
0
Stars
12
SummaryDependencyVersions

ARLAS-server

ARLAS-server provides a highly simplified REST API for exploring data collections available in ElasticSearch. Enhanced capabilities are provided for collections exposing a geometry, a centroid and a timestamp. A Collection API is also provided for managing collections.

Documentation

Prerequisites :

Building

ARLAS-server is a Dropwizard project. You need JDK 17 and Maven 3 to be installed.

Running

You need a Java Runtime (JRE) 17 and an ElasticSearch server running. ARLAS is compliant with the following versions:

ElasticSearch Version
>= 8.13.3

Build

JAR

In order to download the project dependencies and build it :

mvn clean package
Docker
docker build --tag=gisaia/arlas-server:latest --tag=arlas-server:latest .

Run

JAR

To run the project :

java -jar target/arlas-server-x.x.jar server conf/configuration.yaml

Then, go to http://localhost:9999/arlas/swagger for exploring and testing the API.

Docker
docker run -d -p 9999:9999  -e ARLAS_ELASTIC_NODES=my-host:9200 -e ARLAS_ELASTIC_CLUSTER=elasticsearch  gisaia/arlas-server:latest

Running the tests

Integration tests
with docker containers
./scripts/tests-integration.sh

Make sure to have docker installed and running on your system and you might need to install some dependencies :

sudo apt-get install xmlstarlet

Have a look to the official elasticsearch image documentation if you are in trouble with elasticsearch container.

with running elasticsearch and ARLAS-server
export ARLAS_HOST="localhost"; export ARLAS_PORT="9999"; export ARLAS_PREFIX="/arlas/";
export ARLAS_ELASTIC_NODES="localhost:9200";
mvn clean install -DskipTests=false

Built with :

Contributing :

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning :

We use our own versioning schema which looks like 21.0.0 where :

  • 21 : represents ARLAS-server API major version
  • 0 : represents ARLAS-server API minor version
  • 0 : represents ARLAS-server API patch version

For the available versions, see the releases on this repository.

Authors :

See also the list of contributors who participated in this project.

License :

This project is licensed under the Apache License, Version 2.0 - see the LICENSE.txt file for details.

Acknowledgments :

This project has been initiated and is maintained by Gisaïa

The Team
  • Barbet Matthieu
  • Bodiguel Alain
  • Bousquet Sébastien
  • Dezou Laurent
  • Falquier Sébastien
  • Gaudan Sylvain
  • Hamou Mohamed
  • Thiébaud Laurent

Keywords

arlas