React Native client application for COVID Shield on iOS and Android

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.

• Overview
• User experience
• Local development
• Customization
• Localization

Overview

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.

Screenshots

User Experience

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.

Typeface

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.

Inspiration

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.

Design

• Our wired Figma prototype
• Our design working files on Figma.
• Our illustration and animation assets

Content

Our glossary of terms.

Local development

Prerequisites

Follow the steps outlined in React Native Development Environment Setup to make sure you have the proper tools installed.

Node

• Node 12 LTS

iOS

• XCode 11.5 or greater
• iOS device or simulator with iOS 13.5 or greater
• Bundler to install the right version of CocoaPods locally

Android

• Android device or simulator with the ability to run the latest version of Google Play Services.

1. Check out the repository

git clone git@github.com:CovidShield/mobile.git

2. Install dependencies

yarn install

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

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-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.xcworkspace file in the ios folder.
• For Android, using Android Studio by opening android folder.

Development mode

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 (.env*) has TEST_MODE=true. To disable test mode UI on production build, simply set it to false in the environment config file TEST_MODE=false.

Customization

You can customize the look and feel of the app largely by editing values found in the Theme File

Localization

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-translations

Add new translation

1. Create a new i18n file in src/locale/translations/.
2. Add the new option pt in translations.js.
3. Regenerate the translations yarn generate-translations.
4. Add the new option in src/components/LanguageToggle.tsx.
5. Add the new option in src/screens/language/Language.tsx.

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 press@covidshield.app.

Troubleshooting

[Android] Problem with debug.keystore during run Android version

Logs

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 debug.keystore:

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 ~/.android/debug.keystore:

cd android/app
cp debug.keystore ~/.android/debug.keystore

Now you can run yarn run-android in your root folder.