A simple REST API to use JabRef as a service.

We use the Gitflow-Workflow as our Git-Workflow. A detailed description about the workflow can be found here.

1. Run gradle build inside the root folder.
2. When completed, the built product can be found in build/libs/PlanQK Library-1.0-SNAPSHOT.war.

The PlanQK Library is built based on Tomcat in version 10. Thus, earlier version will not be able to host the application since they are not using the Jakarta XML library.

Per default, the service looks for libraries and studies to serve in the user-home/planqk-library directory. It serves all libraries that are located directly in said directory. It serves all studies that are located within the studies folder in said directory.

The default working directory can be changed by setting the LIBRARY_WORKSPACE environment variable to the desired path.

To run the server using docker run:

docker build -t planqk/library:latest . 
docker run -p 2903:2903 -vc:\temp\bibs:/var/planqk-library/ --name PlanQKLibrary planqk/library:latest

Please change c:\temp\bibs to the folder where your bib files reside. Then you can access your bib files at http://localhost:2903/libraries.

Current development is supported by the Federal Ministry for Economic Affairs and Climate Action (BMWK) as part of the PlanQK project (01MK20005N).

Dies ist ein Forschungsprototyp. Die Haftung für entgangenen Gewinn, Produktionsausfall, Betriebsunterbrechung, entgangene Nutzungen, Verlust von Daten und Informationen, Finanzierungsaufwendungen sowie sonstige Vermögens- und Folgeschäden ist, außer in Fällen von grober Fahrlässigkeit, Vorsatz und Personenschäden, ausgeschlossen.

Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work

SPDX-License-Identifier: MIT