Android

Setting up environment

1. First Step

   Follow the cloning procedure stated in Development

2. Second Step

   Windows

   Install Adoptium JavaJDK 21

   Make sure to enable Add JAVA_HOME to PATH during installation.

   MacOS

   brew install openjdk@21
   sudo ln -sfn /opt/homebrew/opt/openjdk@21/libexec/openjdk.jdk /Library/Java/JavaVirtualMachines/openjdk-21.jdk
   echo 'export PATH="/opt/homebrew/opt/openjdk@21/bin:$PATH"' >> ~/.zshrc
   

   Linux

   arch

   pacman -s jdk21-openjdk
   

3. Third Step

   Install Android Studio

   Make sure to download Meerkat Feature Drop | 2024.3.2 from the page
4. Fourth Step

   Add these paths to your environment variables

   C:\Users\$USER\AppData\Local\Android\Sdk\emulator
   C:\Users\$USER\AppData\Local\Android\Sdk\platform-tools
   

5. Fifth Step

   Create a virtual emulator device on Android Studio

   

   or connect your android phone to your computer with USB debugging enabled from Developer settings.

6. Sixth Step

   Generate a keystore by running the command and following the instructions

   keytool -genkey -v -keystore debug.keystore -alias key0 -keyalg RSA -keysize 2048 -validity 10000
   

   Rename the empty example.env to .env in the project root

   KEYSTORE_PATH=<path to your .keystore file>
   KEYSTORE_PASSWORD=<keystore password>
   KEY_PASSWORD=<keystore password>
   KEY_ALIAS=<key alias>
   NODE_ENV=development
   

   and fill the example values according to the instructions

   You can run the pwd command to get the current absolute path of the folder for keystore

Running the app

1. First Step

   Start the Vite development server

   yarn start:renderer
   

2. Second Step

   Start the Capacitor development app

   yarn cap run android -l --port 6969 --host 127.0.0.1 --forwardPorts 6969:6969
   

   The following command will promt you for device selection, select your Emulator or real device and it will install and launch the development app

Debugging (via ADB)

You can see the debug logs with ADB

adb shell 'logcat --pid $(pidof moe.geoxor.amethyst)'

Debugging (via Devtools)

Devtools can be launched in the target device, follow these steps to see how