Setup Guide

Install the local services, configure the iOS app, and verify the basic Kinetic loop.

Overview

This draft should become the first-run guide for a new Kinetic contributor or tester. It should cover the service, the iOS app, and the Shortcut or Action button flow needed to turn a screenshot into an action.

Setup screenshot placeholder

Prerequisites

  • macOS with Xcode installed for the iOS app.
  • Bun installed for the service and web utilities.
  • Docker available for the local Postgres support service.
  • A configured .env in apps/service when running the API locally.

Local service

Start supporting services and run the API:

just support
just dev

For a one-shot service run, use:

just run

iOS app

Open the Xcode project:

just ios-open

Then select the Kinetic scheme and run on a simulator or device. If the app needs a local API URL, document the exact debug configuration here.

Verification checklist

  • The service health endpoint responds locally.
  • The iOS app launches without a local configuration error.
  • A captured screenshot reaches the intended workflow entry point.
  • The result is visible in the app, service logs, or target integration.

Image notes

Drop screenshots or diagrams into apps/docs/public/images and reference them from Markdown with an absolute path:

![Action button setup](/images/action-button-setup.png)