Skip to content

Latest commit

 

History

History
148 lines (101 loc) · 6.69 KB

README.md

File metadata and controls

148 lines (101 loc) · 6.69 KB
Raw

Capture Lite

Get it on Google Play Get it on Google Play

branch build coverage quality
master build Codacy Badge Codacy Badge
develop build Codacy Badge Codacy Badge

Getting Started

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

Development

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

Contribution

  • 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 than Observable when only emitting one value. See issue #233.
  • Avoid using toPromise() to convert Observable to Promise as it is an anti-pattern.

Platform

Android

If your operating system is Linux, set the environment variable CAPACITOR_ANDROID_STUDIO_PATH for your Android Studio. The default value is /usr/local/android-studio/bin/studio.sh.

export CAPACITOR_ANDROID_STUDIO_PATH="/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

Caveat

  • This app is still in the experimental stage.
  • This app uses raw file system to save proofs, and thus the performance is not optimized.

Release

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:

  1. Create release GitHub page with debug APK.
  2. Publish the app to Play Console on alpha track.
  3. Upload debug apk to Google Drive.
  4. Send notification to the private reminder-releases slack channel.

If error occur in deploy-app-store GitHub Action, most likely it's due to some weird error with GitHub MacOS runner or iOS server. Re-run the failed job should fix that. However, you might run into

Error: Validation Failed: {"resource":"Release","code":"already_exists","field":"tag_name"}

In this case, you could delete the releae tag by doing git push --delete origin tagname. E.g. git push --delete origin 0.53.0.