opentrace-ios - GitLite

KO | EN

gitlite — search

#javascript #python #react #typescript #golang #android #machine-learning #rust #linux #nodejs #windows #awesome #vue #mcp

opentrace-ios

(★ 433)

OpenTrace iOS app. Reference implementation of the BlueTrace protocol.

파일 탐색기

최종 버전 다운로드 (.zip)

- info-plist.png
- scheme-view.png
- url-types.png
- user-defined.png
- - Contents.json
- - LaunchScreen.storyboard
  - Main.storyboard
- - BluetraceConfig.swift
  - BlueTraceLocalNotifications.swift
  - BluetraceManager.swift
  - BluetraceUtils.swift
  - CentralController.swift
  - DeviceInfo.swift
  - EncounterMessageManager.swift
  - PeripheralController.swift
- - PushNotificationConstants.swift
- - DatabaseManager.swift
- - Muli-Bold.ttf
  - Muli-BoldItalic.ttf
  - Muli-ExtraLight.ttf
  - Muli-ExtraLightItalic.ttf
  - Muli-Italic.ttf
  - Muli-Light.ttf
  - Muli-LightItalic.ttf
  - Muli-Regular.ttf
  - Muli-Semi-BoldItalic.ttf
  - Muli-SemiBold.ttf
- - OnboardingManager.swift
- - PogoInstructionsViewController.swift
  - PogoManager.swift
- - GradientButton.swift
  - UILabelExtension.swift
  - UITextViewFixed.swift
  - UIViewExtension.swift
- - UploadData.storyboard
- - FirebaseAPIs.swift
  - Logger.swift
  - PlistHelper.swift
- .swiftlint.yml
- AppDelegate.swift
- Info.plist
- Localizable.strings
- Project Bluetrace.entitlements
- - contents.xcworkspacedata
- project.pbxproj
- - IDEWorkspaceChecks.plist
- contents.xcworkspacedata
.gitattributes
.gitignore
.swiftlint.yml
Gemfile
Gemfile.lock
LICENSE.md
OpenTrace.png
Podfile
Podfile.lock
README.md

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/opentrace-community/opentrace-ios

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd opentrace-ios

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Ruby

쉬움 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Ruby bundle 명령어를 쓰려면 Ruby가 필요합니다.

bundle install

Gemfile에 명시된 루비 라이브러리를 설치합니다.

✅ bundle install이 에러 없이 끝나면 README에 안내된 실행 명령어(예: rails server)로 마저 실행해보세요.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# OpenTrace iOS App

![alt text](https://raw.githubusercontent.com/opentrace-community/opentrace-ios/master/OpenTrace.png "OpenTrace Logo")

OpenTrace is the open source reference implementation of BlueTrace.

BlueTrace is a privacy-preserving protocol for community-driven contact tracing across borders. It allows participating devices to log Bluetooth encounters with each other, in order to facilitate epidemiological contact tracing while protecting users’ personal data and privacy. Visit <https://bluetrace.io> to learn more.

The OpenTrace reference implementation comprises:
- Android app: [opentrace-community/opentrace-android](https://github.com/opentrace-community/opentrace-android)
- iOS app: [opentrace-community/opentrace-ios](https://github.com/opentrace-community/opentrace-ios)
- Cloud functions: [opentrace-community/opentrace-cloud-functions](https://github.com/opentrace-community/opentrace-cloud-functions)
- Calibration: [opentrace-community/opentrace-calibration](https://github.com/opentrace-community/opentrace-calibration)

## Building the code

1. Install the latest [Xcode developer tools](https://developer.apple.com/xcode/downloads/) from Apple
2. Install [CocoaPods](https://github.com/CocoaPods/CocoaPods)
3. Clone the repository
4. Run `pod install` at root of project

## Configuration

### Setting up Firebase for Staging and Production

The app relies on Firebase functions to work. More information can be obtained in the [OpenTrace cloud functions repository](https://github.com/opentrace-community/opentrace-cloud-functions).

1. After setting up Firebase, place your configuration files in the respective directories.

```****
    |-- /FIREBASE
        |-- /PROD
            |-- GoogleService-Info.plist
        |-- /STG
            |-- GoogleService-Info.plist
    ```

2. In `Targets > OpenTrace > Build Phases > Setup Firebase Environment GoogleService-Info.plist`, you will find the code that is used to copy the Plist files into the Plist destination.

3. In `Targets > OpenTrace > Info > URL Types`, insert the GoogleService-Info.plist `REVERSED_CLIENT_ID` in URL schemes.

![Image of URL Types](https://raw.githubusercontent.com/opentrace-community/opentrace-ios/master/img/url-types.png)

### Configuring BlueTrace

You can find BlueTrace config variables at `BluetraceConfig.swift`.

### Setting build variables

To configure STG and PROD variables, define them in `Targets > OpenTrace > Build Settings > User-Defined` and declare them in `Info.plist`.

These are some of the User-Defined variables.

```
PRODUCT_BUNDLE_IDENTIFIER
FIREBASE_STORAGE_URL
SERVICE_UUID
V2_CHARACTERISTIC_ID
```

Screenshot of **User-Defined**

![Image of User-Defined](https://raw.githubusercontent.com/opentrace-community/opentrace-ios/master/img/user-defined.png)

Screenshot of **Info.plist**

![Image of Info.plist](https://raw.githubusercontent.com/opentrace-community/opentrace-ios/master/img/info-plist.png)

### Adding a privacy statement URL

Find `ConsentViewController.swift` and replace the placeholder with your privacy statement URL.

``` swift
@IBAction func privacySafeguardsBtn(_ sender: Any) {
        // check if website exists
        guard let url = URL(string: "<PRIVACY_STATEMENT_URL>") else {
            return
        }
...
```

### Setting Firebase remote config

The "Share" message uses Firebase remote config. The key is "ShareText". If it is unable to be retrieved, the app falls back to `defaultShareText`.

## Debug Screen

There is a debug screen accessible within the staging version of the app. This allows you to view the app's Bluetooth communication log. To access it, you first have to set up the app. Then, tap on the home screen image.

## Linting

There's a build script in `Targets > OpenTrace > Build Phases > Swiftlint` which runs [SwiftLint](https://github.com/realm/SwiftLint) on Build.
Run `{PODS_ROOT}/SwiftLint/swiftlint autocorrect` to auto-fix some linting errors.

## Security Enhancements

SSL pinning is not included as part of the repo

## Statement from Apple

The following is a statement from Apple: "To ensure the credibility of health and safety information, Apple is only accepting COVID-19 related apps from recognised entities such as government organisations, health-focused NGOs, companies deeply credentialed in health issues, and medical or educational institutions. Only developers from one of these recognized entities should submit an app related to COVID-19 to the App Store.

For more information visit <https://developer.apple.com/news/?id=03142020a>"

## Known issues

iOS has limitations on background Bluetooth activity. Details are documented in the white paper at [https://bluetrace.io](https://bluetrace.io).