RESKUE App

Initial setup

Follow the React Native development environment setup guide.

NPM registry

One needs to authenticate with our private Package Registry in order to access its packages. To do so create a private access token with the api scope. Then run the following commands after replacing <your_access_token> with your private access token:

• npm config set @ilt-pse:registry https://gitlab-ext.iosb.fraunhofer.de/api/v4/projects/2563/packages/npm/
• npm config set '//gitlab-ext.iosb.fraunhofer.de/api/v4/projects/2563/packages/npm/:_authToken' "<your_access_token>"

Project dependencies

1. Clone the repository
2. Run npm i inside the reskueapp folder

Development

1. Enter the reskueapp folder
2. Start an Android emulator / Connect an Android device
3. Run npm run start (keep it running)
4. Run npm run android

Tests

Unit/Integration/Component Tests

...are automatically run by CI. You can also manually run these test with npm run test. The test files are located in the __tests__ directory.

Coverage

The test coverage of Unit/Integration/Compontent tests can be obtained by running npm run coverage. A pretty HTML based coverage report will be generated. It can be viewed by opening coverage/lcov-report/index.html in your favourite webbroweser.

End to end tests

End-to-end (e2e) tests are not automatically run by CI. This is due to their non-trivial setup, speed and them being more prone to flakiness.

Setup

1. Run the RESKUE Backend in production mode
2. Have admin and helper users with password 1234
3. Have a Pixel 3a Android R Emulator with the name Pixel_3a_API_30_x86. (alternatively add a new configuration to .detoxrc.json)
4. Keep npm run start running in a terminal
5. Build a debug test version of the app with npm run e2e-build-debug
6. Run the tests with npm run e2e-test-debug

NOTE: The .detoxrc.json file contains platform specific build instructions for testable Android builds. These instructions are executed by npm run e2e-build-debug and currently Linux specific. Detox doesn't provide a way to make these instructions multi-platform. One might want to add extra Detox configurations for different Platforms such as Windows or MacOS.

Configuration

The RESKUE app supports multiple configuration environment via react-native-config. Environments are configured using .env files. Variables placed in .env files are accessable from JavaScript, native Android and native iOS files.

By default the .env environment for local development with a locally running backend is used. Other environemnts such as the staging environment (.env.staging) can be used by setting a ENVFILE environment variable. For instance use the following command to run the Android app using the staging environment: ENVFILE=.env.staging npx react-native run-android (Linux).

Troubleshooting

Notifications don't show up

• Make sure the Apps backeground service is started. This can be done by starting the app once or restarting your device.
• Try resetting the Apps cache from the Android device settings. The app caches the ID of the last shown notification. If the backends database was reset (eg. for development reasons), the app might think the notification was already shown.
• Note that notifcations are not pushed to the sending user.
• Note that expected receivers must be in the adressed group.

After updating react-native-kueres dependencies appear to be missing

Perform the following in order:

1. Stop running npm run start processes (if any)
2. Run npm install
3. Run npx react-native start --reset-cache (same as npm run start but resets cache)
4. Run npm run android

Preparing Detox E2E tests fails

Take a look at the "Note" below the Detox setup instructions.