COVID Shield Mobile App
This repository implements a React Native client application for Apple/Google's Exposure Notification framework, informed by the guidance provided by Canada's Privacy Commissioners. For more information on how this all works, read through the COVID Shield Rationale.
This app is built using React Native and designed to work well with patterns on both Android and iOS devices. It works alongside the COVID Shield Diagnosis Server to provide a reference for how a client application for exposure notifications could work.
Aurora Design System
COVID Shield follows design and content guidelines from the Aurora Design System published by the Government of Canada's Digital Enablement Service.
The Aurora Design System recommends Nunito for the app's main typeface. You can download this font from Google Fonts or access it directly using the Google Fonts integration in Figma.
Our onboarding flow was inspired in part by the work done in this Medium article which is shared under the CC 4.0 license. Thanks to @jelle.prins and @ppkorevaar for their initial work.
Our glossary of terms.
Follow the steps outlined in React Native Development Environment Setup to make sure you have the proper tools installed.
- Xcode 11.5 or greater
- iOS device or simulator with iOS 13.5 or greater
- Bundler to install the right version of CocoaPods locally
- You also need a provisioning profile with the Exposure Notification entitlement. For more information, visit https://developer.apple.com/documentation/exposurenotification.
- Android device with the ability to run the latest version of Google Play Services or Google Play Services Beta. Sign up for beta program here https://developers.google.com/android/guides/beta-program.
- You also need a whitelisted APPLICATION_ID that will be used to
publish to Google Play. You could use APPLICATION_ID from Google Sample App for testing purposes
"com.google.android.apps.exposurenotification". Go to Environment config to see how to change APPLICATION_ID.
1. Check out the repository
git clone email@example.com:CovidShield/mobile.git
2. Install dependencies
2.1 Additional step for iOS
2.1.1 Install Cocoapods
sudo gem install cocoapods
2.1.2 Install pods
bundle install && yarn pod-install
3. Environment config
.env and adjust configuration if necessary.
See react-native-config for more information.
ENVFILE=.env.production yarn run-ios ENVFILE=.env.production yarn run-android
4. Start app in development mode
You can now launch the app using the following commands for both iOS and Android.
yarn run-ios yarn run-android
You can also build the app with native development tool:
- For iOS, using Xcode by opening the
CovidShield.xcworkspacefile in the
- For Android, using Android Studio by opening
When the app is running development mode, you can tap on the COVID Shield logo at the top of the app to open the Test menu. This menu enables you to:
- Put the app into test mode to bypass the Exposure Notification API check
- Change the system status
- Change the exposure status
- Send a sample notification
- Reset the app to onboarding state
Note that: Test menu is enabled if the environment config file
TEST_MODE=true. To disable
test mode UI on production build, simply set it to false in the
environment config file
You can customize the look and feel of the app largely by editing values found in the Theme File
The COVID Shield app is available in French and English. Fully localized content can be modified by editing translations files found in the translations directory. More translations can be added by using the same mechanism as French and English.
After modifying the content you must run the
generate-translations command in order for the app to
reflect your changes.
Add new translation
- Create a new i18n file in src/locale/translations/.
- Add the new option
- Regenerate the translations
- Add the new option in src/components/LanguageToggle.tsx.
- Add the new option in src/screens/language/Language.tsx.
- Add the new option in Xcode
Localizationssettings (Project -> CovidShield -> Info tab -> Localizations) and make sure
Launch Screen.storyboardis checked.
See Test Plan
Who built COVID Shield?
We are a group of Shopify volunteers who want to help to slow the spread of COVID-19 by offering our skills and experience developing scalable, easy to use applications. We are releasing COVID Shield free of charge and with a flexible open-source license.
For questions, we can be reached at firstname.lastname@example.org.
[Android] Problem with debug.keystore during run Android version
FAILURE: Build failed with an exception. * What went wrong: Execution failed for task ':app:packageDebug'. > A failure occurred while executing com.android.build.gradle.internal.tasks.Workers$ActionFacade > com.android.ide.common.signing.KeytoolException: Failed to read key AndroidDebugKey from store "/Users/YOUR_USER/.android/debug.keystore": keystore password was incorrect
Generate a new
cd android/app keytool -genkey -v -keystore debug.keystore -storepass android -alias androiddebugkey -keypass android -keyalg RSA -keysize 2048 -validity 10000
Copy your debug.keystore to
cd android/app cp debug.keystore ~/.android/debug.keystore
Now you can run
yarn run-android in your root