{"id":15036890,"url":"https://github.com/square/workflow-kotlin","last_synced_at":"2026-03-11T01:07:26.339Z","repository":{"id":37078682,"uuid":"268864554","full_name":"square/workflow-kotlin","owner":"square","description":"A Swift and Kotlin library for making composable state machines, and UIs driven by those state machines.","archived":false,"fork":false,"pushed_at":"2025-04-10T16:08:37.000Z","size":17900,"stargazers_count":1058,"open_issues_count":174,"forks_count":101,"subscribers_count":22,"default_branch":"main","last_synced_at":"2025-04-13T01:59:34.011Z","etag":null,"topics":["android","kotlin","reactive","state-machine","ui","workflow"],"latest_commit_sha":null,"homepage":"https://square.github.io/workflow","language":"Kotlin","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/square.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-06-02T17:23:30.000Z","updated_at":"2025-04-10T16:08:40.000Z","dependencies_parsed_at":"2022-07-11T19:50:36.471Z","dependency_job_id":"b10c97f1-d277-4f30-834b-3163933320dc","html_url":"https://github.com/square/workflow-kotlin","commit_stats":{"total_commits":2044,"total_committers":71,"mean_commits":"28.788732394366196","dds":0.6262230919765166,"last_synced_commit":"0bcb692b8fb4d4fc02702989dce6e2f3ce996a62"},"previous_names":[],"tags_count":134,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/square%2Fworkflow-kotlin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/square%2Fworkflow-kotlin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/square%2Fworkflow-kotlin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/square%2Fworkflow-kotlin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/square","download_url":"https://codeload.github.com/square/workflow-kotlin/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248654046,"owners_count":21140235,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["android","kotlin","reactive","state-machine","ui","workflow"],"created_at":"2024-09-24T20:32:38.833Z","updated_at":"2026-03-11T01:07:26.294Z","avatar_url":"https://github.com/square.png","language":"Kotlin","funding_links":[],"categories":[],"sub_categories":[],"readme":"# workflow\n\n[![Kotlin CI](https://github.com/square/workflow-kotlin/workflows/Kotlin%20CI/badge.svg)](https://github.com/square/workflow-kotlin/actions?query=branch%3Amain)\n[![Maven Central](https://img.shields.io/maven-central/v/com.squareup.workflow1/workflow-core-jvm.svg?label=Maven%20Central)](https://central.sonatype.com/namespace/com.squareup.workflow1)\n[![GitHub license](https://img.shields.io/badge/license-Apache%20License%202.0-blue.svg?style=flat)](https://www.apache.org/licenses/LICENSE-2.0)\n[![Kotlinlang slack](https://img.shields.io/static/v1?label=kotlinlang\u0026message=squarelibraries\u0026color=brightgreen\u0026logo=slack)](https://kotlinlang.slack.com/archives/C5HT9AL7Q)\n\nWorkflow is an application framework that provides architectural primitives.\n\nWorkflow is:\n\n* Written in and used for Kotlin and Swift\n* A unidirectional data flow library that uses immutable data within each Workflow.\n  Data flows in a single direction from source to UI, and events in a single direction\n  from the UI to the business logic.\n* A library that supports writing business logic and complex UI navigation logic as\n  state machines, thereby enabling confident reasoning about state and validation of\n  correctness.\n* Optimized for composability and scalability of features and screens.\n* Corresponding UI frameworks that bind Rendering data classes for “views”\n  (including event callbacks) to Mobile UI frameworks for Android and iOS.\n* A corresponding testing framework that facilitates simple-to-write unit\n  tests for all application business logic and helps ensure correctness.\n\n## Using Workflows in your project\n\n### Maven Artifacts\n\nArtifacts are hosted on Maven Central. If you're using Gradle, ensure `mavenCentral()` appears in\nyour `repositories` block, and then add dependencies on the following artifacts:\n\n\u003ctable\u003e\n  \u003ctr\u003e\n    \u003cth\u003eMaven Coordinates\u003c/th\u003e\n    \u003cth\u003eDepend on this if…\u003c/th\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd nowrap\u003e\u003ccode\u003ecom.squareup.workflow1:workflow-core-jvm:x.y.z\u003c/code\u003e\u003c/td\u003e\n    \u003ctd\u003eYou are writing a library module/project that uses Workflows, but you don't need to interact\n    with the runtime from the outside.\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd nowrap\u003e\u003ccode\u003ecom.squareup.workflow1:workflow-rx2:x.y.z\u003c/code\u003e\u003c/td\u003e\n    \u003ctd\u003eYou need to interact with RxJava2 from your Workflows.\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd nowrap\u003e\u003ccode\u003ecom.squareup.workflow1:workflow-testing-jvm:x.y.z\u003c/code\u003e\u003c/td\u003e\n    \u003ctd\u003eYou are writing tests. This should only be included as a test dependency.\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd nowrap\u003e\u003ccode\u003ecom.squareup.workflow1:workflow-ui-core-android:x.y.z\u003c/code\u003e\u003c/td\u003e\n    \u003ctd\u003eYou're writing an Android app that uses Workflows.\u003c/td\u003e\n  \u003c/tr\u003e\n\u003c/table\u003e\n\n### Lower-level Artifacts\n\nMost code shouldn't need to depend on these directly. They should generally only be used to build\nhigher-level integrations with UI frameworks.\n\n\u003ctable\u003e\n  \u003ctr\u003e\n    \u003cth\u003eMaven Coordinates\u003c/th\u003e\n    \u003cth\u003eDepend on this if…\u003c/th\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd nowrap\u003e\u003ccode\u003ecom.squareup.workflow1:workflow-runtime-jvm:x.y.z\u003c/code\u003e\u003c/td\u003e\n    \u003ctd\u003eYou need to interact directly with the runtime, i.e. streams of renderings and outputs.\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd nowrap\u003e\u003ccode\u003ecom.squareup.workflow1:workflow-ui-core-common-jvm:x.y.z\u003c/code\u003e\u003c/td\u003e\n    \u003ctd\u003eYou are writing workflow-ui-android for another UI framework. Defines the core types used by\n    that artifact.\u003c/td\u003e\n  \u003c/tr\u003e\n\u003c/table\u003e\n\n### Jetpack Compose support\n\n[Jetpack Compose](https://developer.android.com/jetpack/compose) is the new UI toolkit for Android.\nIt is comparable to SwiftUI for iOS. The main UI artifacts in this repository support standard\nAndroid Views, but various types of Compose integrations are provided under the\n**[compose](/workflow-ui/compose)** folder.\n\nYou'll find workflow + compose info and documentation there.\n\n## Resources\n\n* Wondering why to use Workflow? See\n  [\"Why Workflow\"](https://square.github.io/workflow/userguide/whyworkflow/)\n* There is a [Glossary of Terms](https://square.github.io/workflow/glossary/)\n* We have a [User Guide](https://square.github.io/workflow/userguide/concepts/)\n  describing core concepts.\n* For Kotlin (and Android), there is a codelab style\n  [tutorial](https://github.com/square/workflow-kotlin/tree/main/samples/tutorial) in the repo.\n* For Swift (and iOS), there is also a Getting Started\n  [tutorial](https://github.com/square/workflow-swift/tree/main/Samples/Tutorial) in the repo.\n* There are also a number of\n  [Kotlin samples](https://github.com/square/workflow-kotlin/tree/main/samples)\n  and [Swift samples](https://github.com/square/workflow-swift/tree/main/Samples).\n\n### Support \u0026 Contact\n\nWorkflow discussion happens in the Workflow Community slack. Use this [open invitation](https://join.slack.com/t/workflow-community/shared_invite/zt-a2wc0ddx-4bvc1royeZ7yjGqEkW1CsQ).\n\nWorkflow maintainers also hang out in the [#squarelibraries](https://kotlinlang.slack.com/messages/C5HT9AL7Q)\nchannel on the [Kotlin Slack](https://surveys.jetbrains.com/s3/kotlin-slack-sign-up?_ga=2.93235285.916482233.1570572671-654176432.1527183673).\n\n## Releasing and Deploying\n\nSee [RELEASING.md](RELEASING.md).\n\n## License\n\n\u003cpre\u003e\nCopyright 2019 Square Inc.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n    http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n\u003c/pre\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsquare%2Fworkflow-kotlin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsquare%2Fworkflow-kotlin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsquare%2Fworkflow-kotlin/lists"}