PlanQK Atlas Developer Guide

This document provides an index to all development guidelines and background information of the PlanQK Atlas.

• ADR - list of architectural decision records showing which design decisions were taken during development of the PlanQK Atlas.

Quick Develop

1. Clone the repository git clone https://github.com/PlanQK/QC-Atlas.git.
2. Build the repository mvn package -DskipTests (skiping the tests for a faster build), Java 8 required.
3. Continue your IDE setup:
   • IntelliJ Ultimate
4. Start Postgres Database:
   • Clone the repository git clone https://github.com/UST-QuAntiL/qc-atlas.
   • Startup in this directory via the Compose Dev File:

       $ docker-compose -f docker-compose.yml pull
       $ docker-compose -f docker-compose.yml up
     

5. Start the application (via the runconfig that you configured in step 3)

Main API Enpoints

API-Root: /atlas

Swagger-Documentation: /atlas/swagger-ui

Releases

To update the version for a release, change the version number in the followings files:

• Application.java: version in @OpenApiDefinition
• pom.xml: {version}-SNAPSHOT
• pom.xml: {version}-SNAPSHOT of
• pom.xml: {version}-SNAPSHOT of

License

Copyright (c) 2020-2021 the qc-atlas contributors

See the NOTICE file(s) distributed with this work for additional information regarding copyright ownership.

This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0 which is available at http://www.eclipse.org/legal/epl-2.0, or the Apache Software License 2.0 which is available at https://www.apache.org/licenses/LICENSE-2.0.

SPDX-License-Identifier: EPL-2.0 OR Apache-2.0