Project Documentation

Setup & Build Guide - ClyoWallpaper

This guide walks you through compiling, installing, and testing the ClyoWallpaper application.


Prerequisites

Before building, verify the following are configured on your developer workstation:

  • Android Studio: Version Koala (2024.1.1) or newer.
  • Java Development Kit (JDK): JDK 17 or higher.
  • Android SDK: API Level 34 (Android 14) installed via SDK Manager.

Getting Started

1. Project Import

  1. Launch Android Studio.
  2. Choose Open and select the /home/weexnes/ClyoWallpaper/ClyoWallpaper directory.
  3. Wait for the build system to sync.

2. Running on Device

  1. Enable developer options and USB debugging on your Android phone.
  2. Select app from the run configuration selector.
  3. Click Run to install.

3. CLI Command Reference

Run these commands from the project root:

  • Assemble Debug APK:
    ./gradlew assembleDebug
  • Clean Build Cache:
    ./gradlew clean

Service Configuration & Testing

Since the background scheduler handles network downloads, ensure that:

  1. Your server IP/domain is accessible from the Android device. (If testing on emulator, use http://10.0.2.2:3000 to access localhost).
  2. Battery saver is disabled if you want precise background interval execution.
  3. Ensure the app is granted POST_NOTIFICATIONS permission (Android 13+) so that the persistent foreground cycle notification can render.