openradiation-mobile

Source code is under licence Apache 2.0 (cf https://www.openradiation.org/fr/conditions-dutilisation#licence_apache2)

Design and graphism is protected

Global requirements

Node 22.4.0 (or more recent LTS version) is required to build and test the application.

Then you need to download project dependencies by running npm install in the source directory.

Test in browser

You can test the app in your browser by starting a local server with the following command npm run start. Most of app features won't be available thought since it requires real device hardware like bluetooth.

A fake sensor will be available to simulate measurements.

Android

Requirements

To build your app and run it on Android, you need to download and install Android Studio.

Your PATH environment variable should contain (example for Windows 10 standard installation) :

• C:\Users\\AppData\Local\Android\sdk\tools
• C:\Users\\AppData\Local\Android\sdk\platform-tools
• C:\Program Files (x86)\Common Files\Oracle\Java\javapath

Build

1. Build the Android and/or iOS app with the expected flavor npm run build:mockDevice or npm run build:betaor npm run build
2. You can then open Android Studio manually or using npx cap open android
3. Launch the app on a simulator or phone using Android Studio
4. Build a signed APK using Android Studio

App built with mockDevice or beta environments will send measure to the test API (safe to use for tests).

Don't forget to increase the app version number if you want to upload your build to the playstore.

If you are behind a proxy, before you run npm command :

• Download manually https://services.gradle.org/distributions/gradle-4.1-all.zip then SET CORDOVA_ANDROID_GRADLE_DISTRIBUTION_URL=C\:/path_to_.../gradle-4.1-all.zip (on windows) (Rq : This env variable is in the ..\platforms\android\cordova\lib\builders\GradleBuilder.js file)

• Add this configuration in the gradle.properties file of the project, where the build.gradle file is (PROJECT\platforms\android directory)

  systemProp.http.proxyHost= systemProp.http.proxyPort= systemProp.http.proxyUser= systemProp.http.proxyPassword= systemProp.https.proxyHost= systemProp.https.proxyPort= systemProp.https.proxyUser= systemProp.https.proxyPassword=

Upload on Playstore

Follow the official guide to upload the app to the Playstore (for both beta closed release and prod release).

iOS

To build your app and run it no iOS, you need to download and install Xcode You also need to install ios-deploy with the following command npm i -g ios-deploy.

To run or build the app, you need to sign it, which require :

1. your distribution certificate
2. your development certificate
3. the distribution provisioning profile linked to the app id and your distribution certificate
4. the development provisioning profile linked to the app id, your development certificate and the phone you want to run the app on

Build

1. Build the Android and/or iOS app with the expected flavor npm run build:mockDevice or npm run build:betaor npm run build
2. You can then open XCode manually or using npx cap open ios
3. Launch the app on a simulator or phone using XCode
4. Build the app using XCode

App built with mockDevice or beta environments will send measure to the test API (safe to use for tests).

Don't forget to increase the app version number if you want to upload your build to the AppStore.

Upload on Playstore

1. open the file platforms/ios/OpenRadiation.xarchive
2. if Xcode didn't open automatically, open it and go to Window > Organiser
3. select the last version of your app and click on Upload to app store
4. follow the steps (be sure to select the right certificate and provisioning profile that you downloaded before)
5. wait for the build to be uploaded and ready to use for test (you will receive an email when it's ready)
6. go to App Store Connect and select your app
7. follow the official guide to manage both beta and prod builds

Development considerations

npm run check-outdated allows no make sure the project does not reference outdated dependencies