branch | build | coverage | quality |
---|---|---|---|
master | |||
develop |
Node 16.2.0+ and NPM 7.13.0+ is required.
Install the dependencies.
npm i
Set the system environment variables NUMBERS_STORAGE_BASE_URL
, NUMBERS_STORAGE_TRUSTED_CLIENT_KEY
, and NUMBERS_BUBBLE_DB_URL
before building the app by appending the following string in ~/.profile
:
export NUMBERS_STORAGE_BASE_URL="THE PRIVATE BASE URL"
export NUMBERS_STORAGE_TRUSTED_CLIENT_KEY="THE TRUSTED CLIENT KEY"
export NUMBERS_BUBBLE_DB_URL="THE BUBBLE DB URL"
Preview the app in web browser.
npm run serve
Start a local dev server for app dev/testing.
npm run serve
Run tests.
npm run test
Run tests in headless mode.
npm run test.ci
Lint the projects.
npm run lint
Update cordova-res
(splash screens and launcher icons).
cordova-res android --skip-config --copy
- Run
npm run lint
before each commit. - The committed codes should pass all GitHub checks.
- Use Visual Studio Code with workspace settings for consistent coding style.
- Use Prettier extension to auto format on save.
- Prefer
Promise
thanObservable
when only emitting one value. See issue #233. - Avoid using
toPromise()
to convertObservable
toPromise
as it is an anti-pattern.
If your operating system is Linux, set the linuxAndroidStudioPath
in capacitor.config.json
. For example,
{
"linuxAndroidStudioPath": "/home/username/android-studio/bin/studio.sh"
}
Before running the app with Android Studio, build and sync the dependencies and web assets.
npm run build
npx cap sync android
Open the project in Android Studio.
npx cap open android
The script does the same thing for you.
npm run build.android
- This app is still in the experimental stage.
- This app uses raw file system to save proofs, and thus the performance is not optimized.
Bump version in package.json
.
{
"version": "a.b.c"
}
Bump version in android/app/build.gradle
.
android {
defaultConfig {
versionCode <versionCode += a_diff*100 + b_diff*10 + c_diff>
versionName "a.b.c"
}
}
Run npm i
to update package-lock.json
.
Write the changelog in CHANGELOG.md
.
When push to the master
branch with new version in the package.json
file, GitHub Action would automatically do the following jobs:
- Create release GitHub page with debug APK.
- Publish the app to Play Console on alpha track.
- Upload debug apk to Google Drive.
- Send notification to the private
reminder-releases
slack channel.