search

skiptools / skipapp-showcase

Sample Skip app demonstrating SkipUI components for iOS and Android
https://skip.tools
GNU Lesser General Public License v3.0
24 stars 3 forks source link

readme

Skip Component Showcase

The Skip Showcase app demonstrates many of the components available in SkipUI.

Get it on Google Play Store Get it on App Store

Quickstart

This repository contains an Xcode project with a SwiftUI app that uses the Skip plugin to transpile the app into Kotlin then build and launch it on Android. To get started:

  1. Install skip (requires macOS 13+ with Homebrew, Xcode, and Android Studio) with the Terminal command: 
    $ brew install skiptools/skip/skip
  2. Configure and launch an Android emulator from the Android Studio device manager.
  3. Download this repository as a zip file and unzip it, or clone the repository: 
    $ git clone https://github.com/skiptools/skipapp-showcase.git
  4. Navigate to the Darwin folder and open the Xcode project: Showcase.xcodeproj
  5. Select and Run the Showcase target with an iOS simulator destination; the app will build and run side-by-side on the iOS simulator and Android emulator.

Project

This project was initialized with the command:

skip init --no-module-tests --no-build --icon-color=8E8E93 --free --zero --appid=skip.showcase.App skipapp-showcase Showcase

Testing

The module can be tested using the standard swift test command or by running the test target for the macOS destination in Xcode, which will run the Swift tests as well as the transpiled Kotlin JUnit tests in the Robolectric Android simulation environment.

Parity testing can be performed with skip test, which will output a table of the test results for both platforms.

Running

Xcode and Android Studio must be downloaded and installed in order to run the app in the iOS simulator / Android emulator. An Android emulator must already be running, which can be launched from Android Studio's Device Manager.

To run both the Swift and Kotlin apps simultaneously, launch the FireSideApp target from Xcode. A build phases runs the "Launch Android APK" script that will deploy the transpiled app a running Android emulator or connected device. Logging output for the iOS app can be viewed in the Xcode console, and in Android Studio's logcat tab for the transpiled Kotlin app.