Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/corona-warn-app/cwa-app-ios
Native iOS app using the exposure notification framework from Apple. The CWA development ends on May 31, 2023. You still can warn other users until April 30, 2023. More information:
https://github.com/corona-warn-app/cwa-app-ios
Last synced: 3 months ago
JSON representation
Native iOS app using the exposure notification framework from Apple. The CWA development ends on May 31, 2023. You still can warn other users until April 30, 2023. More information:
- Host: GitHub
- URL: https://github.com/corona-warn-app/cwa-app-ios
- Owner: corona-warn-app
- License: apache-2.0
- Archived: true
- Created: 2020-05-30T08:46:59.000Z (over 4 years ago)
- Default Branch: release/3.2.x
- Last Pushed: 2023-05-16T20:24:57.000Z (over 1 year ago)
- Last Synced: 2024-09-21T21:33:15.612Z (3 months ago)
- Language: Swift
- Homepage: https://coronawarn.app/en/faq/#ramp_down
- Size: 698 MB
- Stars: 1,683
- Watchers: 69
- Forks: 286
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: CODEOWNERS
- Security: SECURITY.md
- Support: .github/SUPPORT.md
Awesome Lists containing this project
- fucking-open-source-ios-apps - Germany - Corona Warn App
README
Corona Warn App - iOS
Development •
Documentation •
Contribute •
Support •
Changelog •
Licensing
The goal of this project is to develop the official Corona-Warn-App for Germany based on the exposure notification API from [Apple](https://www.apple.com/covid19/contacttracing/) and [Google](https://www.google.com/covid19/exposurenotifications/). 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 iOS implementation** of the Corona-Warn-App.
**Visit our [FAQ page](https://www.coronawarn.app/en/faq/) for more information and common issues.**
## Development
### Setup
1. Install Xcode 13.0
2. Open [ENA.xcworkspace](./src/xcode/ENA.xcworkspace)
3. Select the right app scheme.
We added the schema `ENACommunity` to our project which should enable third party developers to run and test the code. This schema uses a mocked implementation of `ExposureManager` in `SceneDelegate` and injects it into the application.
4. Set the user-defined variable to your development team
In the [project.pbxproj](./src/xcode/ENA/ENA.xcodeproj/project.pbxproj) file, set IPHONE_APP_DEV_TEAM for the build setting `Community` to your development team
5. Install SwiftLint
```console
brew install swiftlint
```
6. (Optional) Set up fastlane:
Make sure you have the latest version of the Xcode command line tools installed:
```console
xcode-select --install
```
Install _fastlane_ using [Bundler](https://bundler.io/)
```console
cd src/xcode && bundle install --path vendor/bundle
```
7. (Optional) Add code snippet to Xcode:
CodeSnipets are located inside the folder 'CodeSnippets'.
Copy MARKs.codesnippet to Xcode UserData folder:
```console
cp CodeSnippets/MARKs.codesnippet ~/Library/Developer/Xcode/UserData/CodeSnippets/
```
### Build
After setting up your environment as stated in [Setup](#Setup), you should be able to build the app using the scheme `ENACommunity`.
If you want to use fastlane instead, you can do so by running the following commands:
```console
cd src/xcode && bundle exec fastlane build_community
cd src/xcode && bundle exec fastlane test
```
## Architecture & Documentation
The full documentation for the Corona-Warn-App is in the [cwa-documentation](https://github.com/corona-warn-app/cwa-documentation) repository. The documentation repository contains technical documents, architecture information, UI/UX specifications, and whitepapers related to this implementation.
Automatically generated documentation of the source code can be found at [GitHub Pages](https://corona-warn-app.github.io/cwa-app-ios/index.html)
## Support & Feedback
The following channels are available for discussions, feedback, and support requests:
| Type | Channel |
| ------------------------ | ------------------------------------------------------ |
| **General Discussion** | 
|
| **Feature Requests** | 
|
| **Concept Feedback** | 
|
| **iOS App Issue** | 
|
| **Backend Issue** | 
|
| **Other Requests** | 
|
## Data privacy
For the possibility to read and export the log files which are created and filled at using the app, we ensure respecting the data privacy by censoring private information (e.g. names of people in the contact journal). To ensure an efficient bug fixing on the side of the developers and testers, the corresponding information is still logged but marked as private. This affects that in release builds for the general public, the logged information is replaced by '🙈🙉🙊'. It may appear an additional text which explains what information is censored at this point.
## 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](./CONTRIBUTING.md). By participating in this project, you agree to abide by its [Code of Conduct](./CODE_OF_CONDUCT.md) at all times.
#### SwiftLint
This project uses [SwiftLint](https://github.com/realm/SwiftLint) to ensure a unified code style. The linter is run on every build and shows all warnings and error within Xcode's Issue Navigator.
Please ensure you have installed SwiftLint when working on this project and fix any warnings or error before committing your changes.
Use `brew install swiftlint` to install SwiftLint or download it manually from https://github.com/realm/SwiftLint. When not installed a warning will be triggered during build.
## 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](https://github.com/corona-warn-app/cwa-documentation/blob/master/README.md#repositories).
## 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](./LICENSE).
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](./LICENSE) for the specific language governing permissions and limitations under the License.
Please see the [detailed licensing information](https://api.reuse.software/info/github.com/corona-warn-app/cwa-app-ios) via the [REUSE Tool](https://reuse.software/) for more details.