https://github.com/square/workflow-swift

A Swift and Kotlin library for making composable state machines, and UIs driven by those state machines.
https://github.com/square/workflow-swift

ios reactive state-machine swift workflow

Last synced: 4 months ago
JSON representation

A Swift and Kotlin library for making composable state machines, and UIs driven by those state machines.

• Host: GitHub
• URL: https://github.com/square/workflow-swift
• Owner: square
• License: apache-2.0
• Created: 2020-06-02T17:22:53.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2024-12-19T21:13:02.000Z (10 months ago)
• Last Synced: 2025-01-05T17:46:33.730Z (9 months ago)
• Topics: ios, reactive, state-machine, swift, workflow
• Language: Swift
• Homepage: https://square.github.io/workflow
• Size: 8.62 MB
• Stars: 326
• Watchers: 15
• Forks: 44
• Open Issues: 36
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

          
# Workflow for Swift

![Swift CI](https://github.com/square/workflow-swift/workflows/Swift%20CI/badge.svg)

[![GitHub license](https://img.shields.io/badge/license-Apache%20License%202.0-blue.svg?style=flat)](https://www.apache.org/licenses/LICENSE-2.0)

A unidirectional data flow library for Swift and [Kotlin](https://github.com/square/workflow-kotlin), emphasizing:

* Strong support for state-machine driven UI and navigation.

* Composition and scaling.

* Effortless separation of business and UI concerns.

_**This project is currently in development and the API subject to breaking changes without notice.**

Follow Square's engineering blog, [The Corner](https://developer.squareup.com/blog/), to see when

this project becomes stable._

While the API is not yet stable, this code is in heavy production use in Android and iOS

apps with millions of users.

## Using Workflows in your project

### Swift Package Manager

[![SwiftPM compatible](https://img.shields.io/badge/SwiftPM-compatible-orange.svg)](#swift-package-manager)

If you are developing your own package, be sure that Workflow is included in `dependencies`

in `Package.swift`:

```swift

dependencies: [

    .package(url: "https://github.com/square/workflow-swift", from: "3.11.0")

]

```

In Xcode 11+, add Workflow directly as a dependency to your project with

`File` > `Swift Packages` > `Add Package Dependency...`. Provide the git URL when prompted: `git@github.com:square/workflow-swift.git`.

## Resources

* [Documentation](https://square.github.io/workflow/)

## Local Development

This project uses [Mise](https://mise.jdx.dev/) and [Tuist](https://tuist.io/) to generate a project for local development. Follow the steps below for the recommended setup for zsh.

```sh

# install mise

brew install mise

# add mise activation line to your zshrc

echo 'eval "$(mise activate zsh)"' >> ~/.zshrc

# load mise into your shell

source ~/.zshrc

# install dependencies

mise install

# only necessary for first setup or after changing dependencies

tuist install --path Samples

# generates and opens the Xcode project

tuist generate --path Samples

```

## Releasing and Deploying

See [RELEASING.md](RELEASING.md).

## License


Copyright 2019 Square Inc.


Licensed under the Apache License, Version 2.0 (the "License");

you may not use this file except in compliance with the License.

You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software

distributed under the License is distributed on an "AS IS" BASIS,

WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

See the License for the specific language governing permissions and

limitations under the License.