Suas iOS & Android Unidirectional Flow Architecture

Welcome to the Suas documentation. You'll find comprehensive guides and documentation to help you start working with Suas as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    Guides

Installation

Adding Suas to your project

Installation

Suas is distributed as two libraries:


Suas iOS

Suas on iOS can be installed with Carthage or CocoaPods

Installing with Carthage

Open your Cartfile and append the following:

github "zendesk/suas-ios" "master"

Then build it with carthage update

Installing with CocoaPods

Add pod 'Suas' to your Podfile.

use_frameworks!

source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '8.0'

pod 'Suas'

Then run pod install


Suas Android

Add Suas as a dependency to your build file:

Gradle:

/*---- For Android Plugin 3.x and up ----*/
//suas core
implementation 'com.zendesk.suas:suas:1.0.0'
//suas middleware
implementation 'com.zendesk.suas:suas-thunk:1.2.0'

/*----  For Android Plugin 2.x and below ----*/
//suas core
compile 'com.zendesk.suas:suas:1.0.0'
//suas middleware
compile 'com.zendesk.suas:suas-thunk:1.2.0'

Maven:

<dependency>
  <groupId>com.zendesk.suas</groupId>
  <artifactId>suas</artifactId>
  <version>1.0.0</version>
</dependency>

What's Next

Check how to get started with Suas .

Related Topics

List of example applications built with Suas
Suas core architecture concepts and elements

Developer experience and tooling
Logging in Suas
Using Suas Monitor

Updated about a year ago

Installation


Adding Suas to your project

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.