Development Guide

Setting up a local development environment for Sakayori Music.

Prerequisites

JDK 21
Android platform tools (if you don't have a keystore already)
protobuf-compiler v3.21 or newer

Basic Setup (Linux/macOS)

~git clone https://github.com/Sakayorii/sakayori-music
~cd "Sakayori Music"
~git submodule update --init --recursive
~cd app
~bash generate_proto.sh
~cd ..
# Generate debug keystore if not exists
~[ ! -f "app/persistent-debug.keystore" ] && keytool -genkeypair -v -keystore app/persistent-debug.keystore -storepass android -keypass android -alias androiddebugkey -keyalg RSA -keysize 2048 -validity 10000 -dname "CN=Android Debug,O=Android,C=US" || echo "Keystore already exists."
# Build the FOSS Debug APK
~./gradlew :app:assembleFossDebug
~ls app/build/outputs/apk/foss/debug/app-foss-debug.apk

GitHub Secrets Configuration

This project uses GitHub Secrets to securely store API keys for building releases. These secrets are automatically injected into the build process via GitHub Actions.

Go to your GitHub repository settings.
Navigate to Settings > Secrets and variables > Actions.
Add the following repository secrets:
- LASTFM_API_KEY - Your LastFM API key
- LASTFM_SECRET - Your LastFM secret key
Get your LastFM API credentials from Last.fm API portal.