Skip to content

DEVELOPER_SETUP.md

Latest commit

 

History

History
234 lines (147 loc) · 7.64 KB

DEVELOPER_SETUP.md

File metadata and controls

234 lines (147 loc) · 7.64 KB

Developer Setup Guide

This project is built using React Native.

If this is your first React Native project, visit the React Native team's Getting Started Docs for instructions on how to get set up. Note that we are not using Expo, so you should review docs relevant to using React Native Cli only.

Note, you should have at least Xcode 12.4 in order to run the project on Mac.

Getting Started

First, run yarn install in the root of the project.

Note: You will still need to configure an Android Virtual Device (AVD) after running the script.

Second, run the setup script for your developer environment:

Linux/MacOS

bin/dev_setup.sh

Windows

bin/dev_setup.bat

Environment

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.

Running

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.

Android (Windows, Linux, macOS)

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".

iOS (macOS only)

  1. Ensure you have Xcode installed Link
  2. You will need to run xcode at least once
  3. Once open go to Xcode in the menu bar and got to Open Developer Tool -> Simulator to start an IOS simulator.

First, install the pod files:

yarn install:pod

Then, run the application:

yarn run-ios

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.

Debugging

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.

Localization

This project is using Lokalise for translations

Use the following scripts to keep the local translations in sync with the remote Lokalise translation:

yarn i18n:pull     // pulls new translations from lokalise, requires an API key
yarn i18n:push     // pushes new entries to lokalise, requires an API key

Valid translations are required to pass CI, use the following scrips to keep the local translation file valid:

yarn i18n:check    // checks if all translations have an entry
yarn i18n:extract  // updates en.json to match current entries

Tooling

TypeScript

This project is using typescript.

Run the complier with:

yarn tsc

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.

Prettier

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.

Husky

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.

ESLint

This project is using eslint.

We have linting checks on CI, please make sure to include the checks locally in your IDE.

Checkstyle

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:

  1. Install CheckStyle-IDEA plugin (http://plugins.jetbrains.com/plugin/1065?pr=idea), it can be found via plug-in repository (Settings|Plugins|Browse repositories).
  2. Go to Settings|Editor|Code Style, choose a code style you want to import CheckStyle configuration to.
  3. Click Manage...|Import.., choose "CheckStyle Configuration" and select a corresponding CheckStyle configuration file ( /android/app/checkstyle.xml). Click OK.

Ktlint

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.

Ruby

We use ruby for bin scripts, cocoapods, and fastlane. We recommended asdf as version manager for ruby.

Testing

Tests are ran automatically through Github actions - PRs are not able to be merged if there are tests that are failing.

Static Testing

To run the static analysis tools:

yarn validate

Unit Test

To run the unit tests:

yarn test --watch

Manual Device Testing

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)

Distribution

Android

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