Coder Social home page Coder Social logo

chronontology-backend's Introduction

chronontology-backend

The chronontology backend (formerly known as jeremy) provides access to underlying datastores via its REST api. Detailed information on the REST api can be found here.

Prerequisites

Gradle Version 2

Building and testing the application

For the Component and Integration Tests to run, type in

gradle clean test

To build the application, type in

gradle clean shadowJar

The binary with dependencies can be found here:

build/libs/jeremy.jar

For development the application can be run with

gradle run

Using the server

The application can be used in two modes. In "connect" and in "single" mode. While in "single" mode a single datastore is used, in "connect" mode two datastores are used, one for storing the authoritative versions and one for sharing these data with other applications, so that they can get enriched by the yet to be developed "connect" component.

Also make sure to check out the Rest Api Reference!

Configuring the application

Depending on which configuration you want, and also for configuring other application details, you have to have a config file at application startup.

config.properties

You can find one here. Make sure you revise the settings before startup!

Datastore configurations

For information on how to configure the abovementioned datastores, have a look at the datastore configuration reference.

In any case, the application will need access to at least one elasticsearch instance in order to work. You can either use an external elasticsearch instance on any machine you have access to or you can launch the application with an embedded elasticsearch server. Information on how to configure the application can be found at the elasticsearch server configuration reference.

Note that you may need type mappings for every type used. So make sure you didn't forget to add the mapping to the period type!

Logging to file system

(Un-)comment the appropriate lines in ./src/main/resources/log4j.properties and make sure the server has write access to the specified file.

Starting the application

To run the application, you need the binary, which can get executed like this:

java -jar jeremy.jar

Execution of the main method starts an embedded jetty server.

chronontology-backend's People

Contributors

danielmarreirosdeoliveira avatar dersmon avatar pjominet avatar janwieners avatar tkleinke avatar pgerth avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.