|
Help us stop COVID-19.
COVID PathCheck is a mobile app for digital contract tracing (DCT) sponsored by Path Check a nonprofit and developed by a growing global community of engineers, designers, and contributors. PathCheck is based on research originally conducted at the MIT Media Lab.
The PathCheck Google Apple Exposure Notification (GAEN) solution is a full open source system for deploying the GAEN API. PathCheck GAEN includes a customizable mobile app and a production-ready exposure notification server based on the Google open source project.
| App permissions | Report Diagnosis | Complete Questionaire |
|---|---|---|
 |
 |
 |
What’s truly special about PathCheck is our strong commitment to preserving the privacy of individual users. We're building an application that can help contain outbreaks of COVID-19 without forcing users to sacrifice their personal privacy.
We welcome public health authorities and other organizations implementing digital contact tracing strategies to create custom builds for their specific needs, incorporate PathCheck features into their applications, or create downstream projects that stay linked to the PathCheck project. If intending to fork the repository and develop off of it, be aware that this comes "at your own risk" for continued maintenance.
The rules for GAEN require that each public health authority release their own application. The goal with the PathCheck Project is to support this deployment strategy.
One of the important aspects of the PathCheck open source project is that it's supported by a large community of volunteers in addition to the open source developer community. Spanning as diverse domains as product management, user research, cryptography, security, compliance, design, and videography more than 1,400 Path Check volunteers are working together to support the project and help drive adoption around the world.
Apps Gone Rogue: Maintaining Personal Privacy in an Epidemic - The orginal white paper.
COVID PathCheck Slack - Where the community lives.
Path-Check/covid-safe-paths - PathCheck's GPS based contact tracing solution.
PathCheck is built on React Native v0.61.5
Read the contribution guidelines.
First, run yarn install in the root of the project. Then run the appropriate setup script for your system. This will install relevant packages, walk through Android Studio configuration, etc.
Note: You will still need to configure an Android Virtual Device (AVD) after running the script.
bin/dev_setup.sh
bin/dev_setup.bat
Populate the following 2 .env files with the relevant urls for your GAEN server:
.env # local developer variables
.env.bt # variables used in building binaries
Note: Members of the Path-Check org can complete this step by making a .env file based on the example.env file in the project and inputting their GitHub access token. Then run bin/set_ha.sh ${HA_LABEL} and passing in the 2-letter ha abbreviation as the first argument (i.e. bin/set_ha.sh pc). This will also setup the values for the display name of the applications and will ensure that we are working with the latest configuration.
Note: In some cases, these procedures can lead to the error Failed to load bundle - Could not connect to development server. In these cases, kill all other react-native processes and try it again.
First, in the "android" directory run:
bundle
If you get a Ruby version error, follow the instructions here to fix it.
Then, run the application:
yarn run-android
If you get a 500 local server error, run:
yarn start --reset-cache
If you get a require: cannot load such file -- dotenv (LoadError) error, run:
gem install dotenv
Linting checks are running automatically on CI, to run those checks locally before pushing your code do:
yarn lint:android
Testing:
- To use the EN APIs on Android the Google account on your Android device must be approved. Reach out to the PatchCheck contacts at Google to get added to the list.
- To provide dianogisis keys to the API the applicationId should be whitelisted, you can skip that verification step by checking
Settings > Google > COVID-19 Exposure Notifications > Debug mode > Bypass app signature check - Device storage can be cleared by long-pressing on the app icon in the simulator, clicking "App info", then "Storage", and lastly, "Clear Storage".
First, install the pod files:
yarn install:pod ## only needs to be ran once
Then, run the application:
yarn run-ios
Device storage can be cleared by clicking "Hardware" on the system toolbar, and then "Erase all content and settings".
Privacy settings can be reset by going to Settings > General > Reset > Reset Location & Privacy
Note: Members of the Path-Check org should update the environment variables of the release build corresponding with the health authority, for this we need to execute the script bin/set_ha.sh ${HA_LABEL} where HA_LABEL is the corresponding health authority label. This will setup the values for the display name of the applications and will ensure that we are working with the latest configuration.
react-native-debugger is recommended. This tool will provide visibility of the JSX hierarchy, breakpoint usage, monitoring of network calls, and other common debugging tasks.
This project is using typescript.
Run the complier with:
yarn tsc
Not every file needs to be written in TypeScript, but we are preferring to use TypeScript in general.
Note that for React-Native projects, TypeScript complication is handled by the
metro-bundler build process and there is no need to emit js code into a bundle
as one would do in a web context, hence the inclusion of the --noEmit flag.
This project is using prettier.
We have a local prettierrc file, please make sure your development environment is set to use the project's prettierrc.
This project is using husky to automate running validation and tests locally on a pre-push git hook.
If you ever need to push code without running these scripts, you can pass the
--no-verify flag on git push.
This project is using eslint.
We have linting checks on CI, please make sure to include the checks locally in your IDE.
This project is using checkstyle to run linting checks for Java files (Android).
We are using Google's checkstyle with some minor differences.
To apply the code style to Android Studio you can follow these steps:
- Install CheckStyle-IDEA plugin (http://plugins.jetbrains.com/plugin/1065?pr=idea), it can be found via plug-in repository (Settings|Plugins|Browse repositories).
- Go to Settings|Editor|Code Style, choose a code style you want to import CheckStyle configuration to.
- Click Manage...|Import.., choose "CheckStyle Configuration" and select a corresponding CheckStyle configuration file (
/android/app/checkstyle.xml). Click OK.
This project is using ktlint to run linting checks for Kotlin files (Android).
You can run ./gradlew ktlintformat to automatically format all your Kotlin files.
We use ruby for bin scripts, cocoapods, and fastlane. We recommended asdf as version manager for ruby.
Tests are ran automatically through Github actions - PRs are not able to be merged if there are tests that are failing.
To run the static analysis tools:
yarn validate
To run the unit tests:
yarn test --watch
Snapshot testing is used as a quick way to verify that the UI has not changed. To update the snapshots:
yarn update-snapshots
e2e tests are written using detox. Screenshots of each test run are saved to e2e/artifacts for review.
To run the e2e tests:
yarn detox-setup ## only needs to be run once
yarn build:e2e:ios ## needs to be run after any code change
yarn test:e2e:iphone{11, -se, 8}
Mobile devices come in many different shapes and sizes - it is important to test your code on a variety of simulators to ensure it looks correct on all device types.
Before pushing up code, it is recommended to manually test your code on the following devices:
- Nexus 4 (smaller screen)
- iPhone 8 (smaller screen)
- Pixel 3 XL (larger screen)
- iPhone 11 (screen w/ notch)
Android APKs are automatically distributed (via AppCenter) on each commit to develop Once a new HA is created we need to add some secrets:
- Encoded keystore file (
openssl base64 -A -in key.jks) - Keystore password
- Key password
- AppCenter token