Skip to content
This repository has been archived by the owner on May 16, 2023. It is now read-only.

Latest commit

 

History

History
211 lines (149 loc) · 11.1 KB

README.md

File metadata and controls

211 lines (149 loc) · 11.1 KB

Data Donation Server

DevelopmentService APIsSpring ProfilesDocumentationSupportContributeContributorsRepositoriesLicensing

The Data Donation Server for receiving and storing users usage data and event driven user surveys.

Architecture Overview

You can find the architecture overview here, which will give you a good starting point in how the backend services interact with other services, and what purpose they serve.

Development

After you've checked out this repository, you can run the application in one of the following ways:

  • As a Docker-based deployment on your local machine. You can run either:
    • Single components using the respective Dockerfile or
    • The full backend using the Docker Compose (which is considered the most convenient way)
  • As a Maven-based build on your local machine. If you want to develop something in a single component, this approach is preferable.

Docker-Based Deployment

If you want to use Docker-based deployment, you need to install Docker on your local machine. For more information about downloading and installing Docker, see the official Docker documentation.

Running the Full CWA Data Donation Backend Using Docker Compose

For your convenience, a full setup for local development and testing purposes, including the generation of test data has been prepared using Docker Compose. To build the backend services, run docker-compose build in the repository's root directory. A default configuration file can be found under .env in the root folder of the repository. If the endpoints are to be exposed to the network the default values in this file should be changed before docker-compose is run.

Once the services are built, you can start the whole backend using docker-compose up.

The docker-compose contains the following services:

Service Description Endpoint and Default Credentials
edus The event-driven user survey service http://localhost:8103
ppac The privacy-preserving access control http://localhost:8104
retention The retention service NO ENDPOINT
postgres-ppdd A postgres database installation localhost:8002
postgres-ppdd:5432 (from containerized pgadmin)
Username: postgres
Password: postgres
pgadmin-ppdd A pgadmin installation for the postgres database http://localhost:8001
Username: admin
Password: admin

Maven-Based Build

If you want to actively develop in one of the services, the Maven-based runtime is most suitable. To prepare your machine to run the CWA project locally, we recommend that you first ensure that you've installed the following:

If you are already running a local Postgres, you need to create a database cwa and run the following setup scripts:

Configure

After you made sure that the specified dependencies are running, configure them in the respective configuration files.

Build

After you've checked out the repository, to build the project, run mvn install in your base directory.

Run

Run via Terminal

Navigate to the service you want to start and run the spring-boot:run target. The configured Postgres and the configured S3 compliant object storage are used as default. When you start the submission service, the endpoint is available on your local port 8080.

If you want to start the submission service, for example, you start it as follows:

  cd services/edus/
  mvn spring-boot:run
Run via IDE

If you want to run a service in your favorite IDE, there are already maven run configurations provided for edus and ppac.

Debugging

To enable the DEBUG log level, you can run the application using the Spring debug profile.

mvn spring-boot:run -Dspring.profiles.active=debug

To be able to set breakpoints (e.g. in IntelliJ), it may be necessary to use the -Dspring-boot.run.fork=false parameter.

Service APIs

The API that is being exposed by the backend services is documented in an OpenAPI specification. The specification files are available at the following locations:

Service OpenAPI Specification
EDUS Service services/edus/api_v1.json
PPAC Service services/ppac/api_v1.json

Spring Profiles

Will follow soon.

Documentation

The full documentation for the Corona-Warn-App can be found in the cwa-documentation repository. The documentation repository contains technical documents, architecture information, and whitepapers related to this implementation.

The documentation for cwa-server can be found under the /docs folder.

The JavaDoc documentation for cwa-server is hosted by Github Pages at https://corona-warn-app.github.io/cwa-server.

Support and Feedback

The following channels are available for discussions, feedback, and support requests:

Type Channel
General Discussion
Concept Feedback
Backend Issue
Other Requests

How to Contribute

Contribution and feedback are encouraged and always welcome. For more information about how to contribute, the project structure, as well as additional contribution information, see our Contribution Guidelines. By participating in this project, you agree to abide by its Code of Conduct at all times.

Contributors

The German government has asked SAP and Deutsche Telekom to develop the Corona-Warn-App for Germany as open source software. Deutsche Telekom is providing the network and mobile technology and will operate and run the backend for the app in a safe, scalable and stable manner. SAP is responsible for the app development, its framework and the underlying platform. Therefore, development teams of SAP and Deutsche Telekom are contributing to this project. At the same time our commitment to open source means that we are enabling -in fact encouraging- all interested parties to contribute and become part of its developer community.

Repositories

A list of all public repositories from the Corona-Warn-App can be found here.

Licensing

Copyright (c) 2021-2023 SAP SE or an SAP affiliate company and Corona-Warn-App contributors.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.

You may obtain a copy of the License from here.

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the LICENSE for the specific language governing permissions and limitations under the License.

Please see the detailed licensing information via the REUSE Tool for more details.