Cross-platform desktop app for visualizing and debugging apps built with Suas
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.vscode
app
assets/icon
misc
.gitignore
.nvmrc
.travis.yml
CONTRIBUTING.md
LICENSE
README.md
main.ts
package-lock.json
package.json
preprocessor.js
tsconfig.json
tslint.json
webpack.config.js

README.md

Build Status License Join the chat at https://gitter.im/SuasArch/Lobby

Analytics

Suas Monitor

Suas Monitor is a cross-platform desktop application that helps visualizing and debugging the state and actions of apps built with Suas. Check this video for a demo.

Read more about how to use Suas Monitor in your apps at Suas documentation website.

What is Suas

Suas is a unidirectional data flow architecture implementation for iOS/macOS/tvOS/watchOS and Android heavily inspired by Redux. It provides an easy-to-use library that helps to create applications that are consistent, deterministic, and scalable.

Suas focuses on providing good developer experience and tooling such as customizable logging and state changes monitoring.

Suas can be found on GitHub:

Join our gitter chat channel for any questions. Or check Suas documentatation website.

Installing Suas

Suas Monitor can be used on macOS, windows and linux. At the moment we provide pre-built binaries for macOS only. To Install it on Windows and Linux you can build it from source.

macOS prebuilt binary can be found on GitHub release page.

You can also install it using Homebrew:

brew tap zendesk/suas
brew cask install suas-monitor

Building from source

Install the dependencies using npm:

npm install

To run it in development mode, use:

npm run dev

And to built it in production:

npm run build && npm start

Packaging

Make sure you have npm version 5.2 (version 5.3 has a problem when packaging).

Prerequisite On Mac, Make sure you have wine:

brew cask install xquartz
brew install wine

Scripts:

Package mac app

npm run package-mac

Package mac app and zip it

npm run package-mac-zip

Package a windows app

npm run package-win-32
npm run package-win-64

Package a linux app

npm run package-linux-32
npm run package-linux-64

Package all versions

npm run package

Where to go next

To get more information about Suas:

Contributing

We love any sort of contribution. From changing the internals of how Suas works, changing Suas methods and public API, changing readmes and documentation topics.

Feel free to suggest changes on the GitHub repos or directly in Saus gitter channel.

For reference check our contributing guidelines.

Contact us

Join our gitter channel to talk to other Suas developers.

For any question, suggestion, or just to say hi, you can find the core team on twitter:

Suas future

To help craft Suas future releases, join us on gitter channel.

Copyright and license

Copyright 2017 Zendesk, 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.