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.
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
- Android device or simulator with the ability to run the latest version of Google Play Services.
git clone [email protected]:CovidShield/mobile.gityarn installcd ios && pod install
Check .env and adjust configuration if necessary. See react-native-config for more information.
Ex:
ENVFILE=.env.production yarn run-ios
ENVFILE=.env.production yarn run-androidYou can now launch the app using the following commands for both iOS and Android.
yarn run-ios
yarn run-androidYou can also build the app with native development tool:
- For iOS, using XCode by opening the
CovidShield.xcworkspacefile in theiosfolder. - For Android, using Android Studio by opening
androidfolder.
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:
- Switch languages
- 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
Test mode UI is enabled if the environment config file (.env*) has TEST_MODE=true. To toggle test mode UI, you can swipe right to left at home screen or press on CovidShield logo.
Some features in test mode:
- Toggle language.
- Show sample exposed notification.
- Mock server. When it is enabled, it will override Google / Apple Exposure Notification framework and backend for system status, exposure status.
To disable test mode UI on production build, simply set it to false in the environment config file TEST_MODE=false.
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.
yarn generate-translationsWe 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 [email protected].