Love Letter Game - Kotlin Multiplatform

A cross-platform multiplayer implementation of the Love Letter card game built with Kotlin Multiplatform, Compose Multiplatform, and Supabase.

🎮 Features

• ✅ Cross-Platform: Android, iOS, Web (Wasm), Desktop (JVM)
• ✅ Real-time Multiplayer: Using Supabase for instant synchronization
• ✅ Full Game Logic: All 8 Love Letter cards with proper rules
• ✅ User Authentication: Sign up/sign in with Supabase Auth
• ✅ Game Lobby System: Create and join games
• ✅ Modern UI: Built with Compose Multiplatform

🚀 Quick Start

See SETUP_INSTRUCTIONS.md for detailed setup instructions.

Prerequisites

• Docker & Docker Compose
• JDK 17+
• Android SDK (for mobile builds)

Run Locally

# Start Supabase
docker-compose up -d

# Run Web version
./gradlew :composeApp:wasmJsBrowserDevelopmentRun

# Run Desktop version
./gradlew :composeApp:run

📱 Platforms

This is a Kotlin Multiplatform project targeting Android, iOS, Web, Desktop (JVM), Server.

• /composeApp is for code that will be shared across your Compose Multiplatform applications. It contains several subfolders:

  • commonMain is for code that’s common for all targets.
  • Other folders are for Kotlin code that will be compiled for only the platform indicated in the folder name. For example, if you want to use Apple’s CoreCrypto for the iOS part of your Kotlin app, the iosMain folder would be the right place for such calls. Similarly, if you want to edit the Desktop (JVM) specific part, the jvmMain folder is the appropriate location.

• /iosApp contains iOS applications. Even if you’re sharing your UI with Compose Multiplatform, you need this entry point for your iOS app. This is also where you should add SwiftUI code for your project.

• /server is for the Ktor server application.

• /shared is for the code that will be shared between all targets in the project. The most important subfolder is commonMain. If preferred, you can add code to the platform-specific folders here too.

🏗️ CI/CD

This project uses GitHub Actions for continuous integration and deployment:

• CI Pipeline: Builds and tests on every push and PR

  • Runs unit tests
  • Builds all platform targets (Android, Desktop, Web)
  • Uploads build artifacts
  • Validates docker-compose setup

• Release Pipeline: Creates releases when tags are pushed

  • Builds production APK, Desktop packages, and Web bundle
  • Creates GitHub releases with downloadable artifacts
  • Deploys web version to GitHub Pages

• PR Checks: Automated code review on pull requests

  • Validates PR title format
  • Checks APK size
  • Runs security scans
  • Posts build results as comments

• Dependabot: Automatic dependency updates for GitHub Actions, Gradle, and Docker

Triggering Workflows

# Push to trigger CI
git push origin main

# Create release
git tag -a v1.0.0 -m "Release version 1.0.0"
git push origin v1.0.0

# Manual deployment
# Go to Actions tab → Deploy Web → Run workflow

📦 Project Structure

LoveLetterGame/
├── .github/
│   ├── workflows/
│   │   ├── ci.yml              # Main CI pipeline
│   │   ├── release.yml         # Release and artifact creation
│   │   ├── pr-checks.yml       # PR validation
│   │   └── deploy-web.yml      # Web deployment
│   └── dependabot.yml          # Dependency updates
├── composeApp/                 # UI application
├── shared/                     # Shared business logic
├── supabase/                   # Database and backend setup
├── docker-compose.yml          # Local Supabase
└── README.md

Build and Run Android Application

To build and run the development version of the Android app, use the run configuration from the run widget in your IDE’s toolbar or build it directly from the terminal:

• on macOS/Linux

  ./gradlew :composeApp:assembleDebug

• on Windows

  .\gradlew.bat :composeApp:assembleDebug

Build and Run Desktop (JVM) Application

To build and run the development version of the desktop app, use the run configuration from the run widget in your IDE’s toolbar or run it directly from the terminal:

• on macOS/Linux

  ./gradlew :composeApp:run

• on Windows

  .\gradlew.bat :composeApp:run

Build and Run Server

To build and run the development version of the server, use the run configuration from the run widget in your IDE’s toolbar or run it directly from the terminal:

• on macOS/Linux

  ./gradlew :server:run

• on Windows

  .\gradlew.bat :server:run

Build and Run Web Application

To build and run the development version of the web app, use the run configuration from the run widget in your IDE's toolbar or run it directly from the terminal:

• for the Wasm target (faster, modern browsers):
  • on macOS/Linux

    ./gradlew :composeApp:wasmJsBrowserDevelopmentRun

  • on Windows

    .\gradlew.bat :composeApp:wasmJsBrowserDevelopmentRun

• for the JS target (slower, supports older browsers):
  • on macOS/Linux

    ./gradlew :composeApp:jsBrowserDevelopmentRun

  • on Windows

    .\gradlew.bat :composeApp:jsBrowserDevelopmentRun

Build and Run iOS Application

To build and run the development version of the iOS app, use the run configuration from the run widget in your IDE’s toolbar or open the /iosApp directory in Xcode and run it from there.

---

Learn more about Kotlin Multiplatform, Compose Multiplatform, Kotlin/Wasm…

We would appreciate your feedback on Compose/Web and Kotlin/Wasm in the public Slack channel #compose-web. If you face any issues, please report them on YouTrack.