pj/sanderling

0 Fork 0

mirror of https://github.com/priyanshujain/sanderling.git synced 2026-10-02 19:17:10 +00:00

Files

T

pj dc3ff34c06 docs(getting-started): add iOS path, separate folio and folio-web

Document just test-ios under examples/folio, and distinguish the KMP
sample from the React + Vite folio-web sample.

2026-05-15 16:58:28 +05:30

2.3 KiB

Raw Blame History

title

title
Getting started

Getting started

Install the CLI, run a spec.

Prerequisites

Android / iOS:

An Android emulator with API level 30 or newer (or a connected device).
adb on your PATH.

Web:

Chrome installed. sanderling drives it via CDP; no other setup required.

Run sanderling doctor to check the host environment.

Install

CLI

curl -fsSL https://raw.githubusercontent.com/priyanshujain/sanderling/master/install.sh | bash

Spec package (npm)

npm install --save-dev @sanderling/spec

Your first run

The repo ships two sample apps. examples/folio is a Kotlin Multiplatform personal-ledger app that covers Android, iOS, and web (wasmJs) from one shared codebase. examples/folio-web is a smaller React + Vite app that covers only the web path. Both carry a TypeScript spec under sanderling/spec.ts. Install just, then pick a target below.

Android

From examples/folio:

just install   # build and install the folio APK on a booted emulator or device
just test      # run the spec

With no device connected and multiple AVDs, pick one:

AVD=Pixel_7 just test

Persistent settings can live in a .env alongside the justfile (AVD=Pixel_7, DURATION=5m, and so on).

iOS

From examples/folio (requires Xcode 16+ and xcodegen):

just test-ios                          # default simulator: iPhone 17 Pro
IOS_DEVICE="iPhone 15" just test-ios   # pick a different simulator

just test-ios boots the simulator if needed, builds and installs the app, then runs sanderling test --platform ios.

Web

From either example. For the KMP wasmJs build, use examples/folio:

just web       # serve the wasmJs app on a webpack dev server

For the React + Vite build, use examples/folio-web:

just test      # starts the Vite dev server, then sanderling drives Chrome via CDP

No emulator or SDK setup needed for either web path.

Trace output

When the run ends, the trace lands in sanderling/runs/<timestamp>/:

runs/2026-04-18T12-34-56/
├── trace.jsonl
├── screenshots/
└── meta.json

Browse it with sanderling inspect (see inspect), or read trace.jsonl step by step.

Next: writing specs.

2.3 KiB Raw Blame History