https://github.com/skiptools/skipapp-showcase

Sample Skip app demonstrating SkipUI components for iOS and Android
https://github.com/skiptools/skipapp-showcase

Last synced: about 2 months ago
JSON representation

Sample Skip app demonstrating SkipUI components for iOS and Android

• Host: GitHub
• URL: https://github.com/skiptools/skipapp-showcase
• Owner: skiptools
• License: lgpl-3.0
• Created: 2023-08-25T19:00:05.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-07-26T21:31:54.000Z (about 2 months ago)
• Last Synced: 2024-07-26T23:01:30.041Z (about 2 months ago)
• Language: Swift
• Homepage: https://skip.tools
• Size: 2.51 MB
• Stars: 17
• Watchers: 5
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.LGPL

Awesome Lists containing this project

README

        
# Skip Component Showcase

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

[](https://play.google.com/store/apps/details?id=org.appfair.app.Showcase) [](https://apps.apple.com/us/app/skip-showcase/id6474885022)

## 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](https://brew.sh), [Xcode](https://developer.apple.com/xcode/), and [Android Studio](https://developer.android.com/studio)) with the Terminal command:

```

$ brew install skiptools/skip/skip

```

2. Configure and launch an Android emulator from the [Android Studio device manager](https://developer.android.com/studio/run/emulator-launch-without-app).

3. Download this [repository as a zip file](https://github.com/skiptools/skipapp-showcase/archive/main.zip) 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.