GETTING_STARTED.md

Getting Started

In order to build the project, make sure that you first clone all of the submodules:

$ git submodules update --init --recursive

Dependencies

You will need to install JDK 19 (to run Gradle) and Node.js (to compile the web extension). There are a few different ways to install these:

Nix

If you have Nix and direnv installed, these dependencies will be installed for you automatically. When your shell is inside of the repository, it will populate JAVA_HOME for you and node and npm will be part of your PATH.

Xcode will find the dependencies automatically, but Android Studio will have to be configured manually. You will need to find the JDK path:

$ echo $JAVA_HOME

and then set this path in Android Studio in Preferences -> Build, Execution, Deployment -> Build Tools -> Gradle -> Gradle JDK.

Homebrew

If you are developing on macOS, you can use Homebrew. You will need to install the following dependencies:

$ brew install node
$ brew install --cask temurin

Xcode will automatically find these dependencies, but you will need to configure Android Studio manually. You will need to select temurin-19 in Android Studio in Preferences -> Build, Execution, Deployment -> Build Tools -> Gradle -> Gradle JDK.

Building

macOS and iOS

In order to build for Apple platforms, you will need to be developing on a Mac and you will need to download Xcode.

Open the Xcode project (Apple/Wallet.xcodeproj) and build and run the app using the App (iOS) or App (macOS) schemes.

Android

In order to build for Android, you will need to download Android Studio.

Open the repository in Android Studio and build and run the app using the Android configuration.