Awesome
<h1 align="center"> Corona Warn App - Android </h1> <p align="center"> <a href="https://github.com/corona-warn-app/cwa-app-android/issues" title="Open Issues"> <img src="https://img.shields.io/github/issues/corona-warn-app/cwa-app-android"> </a> <a href="https://github.com/corona-warn-app/cwa-app-android/actions/workflows/build_and_test.yml" title="Build Status"> <img src="https://github.com/corona-warn-app/cwa-app-android/actions/workflows/build_and_test.yml/badge.svg"> </a> <a href="https://sonarcloud.io/component_measures?id=corona-warn-app_cwa-app-android&metric=Coverage&view=list" title="Coverage"> <img src="https://sonarcloud.io/api/project_badges/measure?project=corona-warn-app_cwa-app-android&metric=coverage"> </a> <a href="./LICENSE" title="License"> <img src="https://img.shields.io/badge/License-Apache%202.0-green.svg"> </a> <a href="https://api.reuse.software/info/github.com/corona-warn-app/cwa-app-android" title="REUSE Status"> <img src="https://api.reuse.software/badge/github.com/corona-warn-app/cwa-app-android"> </a> </p> <p align="center"> <a href="#architecture--documentation">Documentation</a> • <a href="#how-to-contribute">Contribute</a> • <a href="#support--feedback">Support</a> • <a href="https://github.com/corona-warn-app/cwa-app-android/releases">Changelog</a> • <a href="#licensing">Licensing</a> </p>The goal of this project is to develop the official Corona-Warn-App for Germany based on the exposure notification API from Apple and Google. The apps (for both iOS and Android) use Bluetooth technology to exchange anonymous encrypted data with other mobile phones (on which the app is also installed) in the vicinity of an app user's phone. The data is stored locally on each user's device, preventing authorities or other parties from accessing or controlling the data. This repository contains the native Android implementation of the Corona-Warn-App. Visit our FAQ page for more information and common issues
Known Issues
-
Activating exposure logging on a test version of the Android app requires a Google account which has been allowlisted for this purpose by Google (see Exposure Notifications implementation guide - Prerequisites). Google only allowlists official development partners: general CWA community members are not included. If you try to activate exposure logging and your account is not allowlisted then you will see the error message "Cause 3". Other functionality in the app which does not rely on exposure logging can however still be tested.
-
The Storage is currently based on Encrypted Shared Preferences and SQL Cipher (SQLite) - this could change in the future
-
Test Coverage is generally low and needs to be improved. We appreciate your help here!
-
In General every TODO comment within the code or the documentation can be regarded as an issue. You are free to tackle the TODOs anytime!
-
We are aware of the Play Store Limitations of GMS.
-
Without your own server instance (e.g. a local Docker setup), you will not be able to test the Application. For help, please refer to the server implementation.
-
Strings including translations are provided and approved by the UA team. For suggestions / findings please open a dedicated issue.
Architecture & Documentation
The full documentation for the Corona-Warn-App is in the cwa-documentation repository. The documentation repository contains technical documents, architecture information, UI/UX specifications, and whitepapers related to this implementation.
Support & Feedback
The following channels are available for discussions, feedback, and support requests:
Type | Channel |
---|---|
General Discussion | <a href="https://github.com/corona-warn-app/cwa-documentation/issues/new/choose" title="General Discussion"><img src="https://img.shields.io/github/issues/corona-warn-app/cwa-documentation/question.svg?style=flat-square"></a> </a> |
Feature Requests | <a href="https://github.com/corona-warn-app/cwa-wishlist/issues/new/choose" title="Create Feature Request"><img src="https://img.shields.io/github/issues/corona-warn-app/cwa-wishlist?style=flat-square"></a> |
Concept Feedback | <a href="https://github.com/corona-warn-app/cwa-documentation/issues/new/choose" title="Open Concept Feedback"><img src="https://img.shields.io/github/issues/corona-warn-app/cwa-documentation/architecture.svg?style=flat-square"></a> |
Android App Issue | <a href="https://github.com/corona-warn-app/cwa-app-android/issues/new/choose" title="Open Android Issue"><img src="https://img.shields.io/github/issues/corona-warn-app/cwa-app-android?style=flat-square"></a> |
Backend Issue | <a href="https://github.com/corona-warn-app/cwa-server/issues/new/choose" title="Open Backend Issue"><img src="https://img.shields.io/github/issues/corona-warn-app/cwa-server?style=flat-square"></a> |
Other Requests | <a href="mailto:corona-warn-app.opensource@sap.com" title="Email CWA Team"><img src="https://img.shields.io/badge/email-CWA%20team-green?logo=mail.ru&style=flat-square&logoColor=white"></a> |
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) 2020-2023 SAP SE or an SAP affiliate company.
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.