ameinc/realm-crowdcircle

A collaborative experimental game, played between 6 teams

Realm Crowd Circle

A small demo app designed to demonstrate simple instantaneous collaboration of up to 6 groups in an artistic style game.

One device runs as a "host", which will display circles representing 6 separate clients. Other devices can then connect as clients. When a client taps on the circle button on their screen, the equivalent circle on the host will increment. Over time, the values on the host will decrease until they reach 0 again.

Features

• Works with 1 host iPad and up to 6 iPhone / iPad units.
• Locally hosted; one iPad acts like the host.
• Springy animations to elicit a playful response with users.

Requirements

• iOS 9.0 and above
• Xcode 8.33 and higher
• Realm Platform / Realm Object Server 2.x
• Realm Studio

Realm Platform

This application demonstrates features of the Realm Platform and needs to have a working instance of the Realm Object Server version 2.x to make data available between instances of the CrowdCircle app. The Realm Object Server can be installed via npm as a node application for macOS or Linux. Please see the installation instructions. If you already got Node.js installed, it's a one-liner.

Realm Studio

Another useful tool is Realm Studio which is available for macOS, Linux and Windows and allows developers to inspect and manage Realms and the Realm Object Server. Realm Studio is recommended for all developers and can be downloaded from the Realm web site.

CocoaPods is required in order to install all of the third party dependencies (such as Realm itself) into Realm Crowd Circle.

1. If you haven't already, install CocoaPods.
2. Open Terminal, and navigate to the root Realm Puzzle directory, e.g. cd ~/Projects/realm-crowdcircle.
3. Run pod install to install the necessary dependencies needed by Realm Crowd Circle.
4. Start Realm Object Server on a local Mac.
5. Using Realm Studio, connect to the local Realm Object Server -- the default username and password (realm-admin and an empty password) are provided which will work for a fresh installation of the object server. Then, in the Users pane, create a user named '[email protected]' using the password 'password'.
6. Build the apps and deploy to all devices.

The app will try to insert the correct local IP address at build time, but if that isn't appropriate, it's possible to manually set the host name upon launch as well.

Third Party Dependencies

The following modules will be installed as part of the CocoaPods installation:

• Realm Swift - The Objective-C version of the Realm Mobile Database.

• Eureka - A framework for easily setting up input forms in iOS.

• SwiftSpinner - A fullscreen loading spinner UI.

Contributing

See CONTRIBUTING.md for more details!

This project adheres to the Contributor Covenant Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].

License

Distributed under the Apache license. See LICENSE for more information.