# SwiftBrowser

> Run SwiftUI apps in the browser: an iOS app compiles unchanged to WebAssembly against an API-compatible SwiftUI shim and runs inside an iPhone frame, or full screen on a phone.

Every page is also available as Markdown at the URLs below, and the whole site as one document at https://swiftbrowser-docs.pages.dev/llms-full.txt.

## Guide

- [Overview](https://swiftbrowser-docs.pages.dev/index.md): What SwiftBrowser is, the four CLI commands, and where everything is documented.
- [Getting started](https://swiftbrowser-docs.pages.dev/getting-started.md): From an Xcode project to a deployed static site: doctor, check, dev and build.
- [Compatibility](https://swiftbrowser-docs.pages.dev/compatibility.md): The SwiftUI, SwiftData, Foundation and framework APIs the browser build supports, and what is not there yet.

## Reference

- [CLI](https://swiftbrowser-docs.pages.dev/cli.md): The @swiftbrowser/cli commands, swiftbrowser.json, Foundation and ICU data, frameworks, Core ML and Swift packages.
- [@swiftbrowser/xcodeproj](https://swiftbrowser-docs.pages.dev/xcodeproj.md): A dependency-free TypeScript reader for Xcode projects: targets, sources, resources and build settings.

## Internals

- [Architecture](https://swiftbrowser-docs.pages.dev/architecture.md): How the SwiftUI shim, the render ops and the TypeScript renderer fit together.
- [Ops protocol](https://swiftbrowser-docs.pages.dev/ops-protocol.md): The messages between the Swift runtime and the renderer: ops, events, layout and state snapshots.
- [Web renderer](https://swiftbrowser-docs.pages.dev/web-renderer.md): The @swiftbrowser/web renderer, dev server, app registry and static site build.

## Project

- [Contributing](https://swiftbrowser-docs.pages.dev/contributing.md): Building and testing SwiftBrowser itself, CI, deploying the examples and releasing to npm.
- [History](https://swiftbrowser-docs.pages.dev/history.md): What each development phase added, oldest first.