Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/realm/realm-tasks

To Do app built with Realm, inspired by Clear for iOS
https://github.com/realm/realm-tasks

android cocoa react-native realm xamarin

Last synced: about 2 months ago
JSON representation

To Do app built with Realm, inspired by Clear for iOS

Host: GitHub
URL: https://github.com/realm/realm-tasks
Owner: realm
License: other
Archived: true
Created: 2016-04-12T01:26:28.000Z (over 8 years ago)
Default Branch: master
Last Pushed: 2021-11-23T11:14:25.000Z (almost 3 years ago)
Last Synced: 2024-09-23T02:02:19.602Z (about 2 months ago)
Topics: android, cocoa, react-native, realm, xamarin
Language: Swift
Size: 3.39 MB
Stars: 369
Watchers: 37
Forks: 71
Open Issues: 85
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

README

# Realm Tasks (DEPRECATED)

**This project is deprecated and is no longer actively maintained.**

> A basic task management app, designed as a *homage* to [Realmac Software's Clear](http://realmacsoftware.com/clear),
with their knowledge and permission.

![Realm Tasks](screenshot.jpg)

**Warning:** This project is very much a work in progress, being used as a testbed for new Realm technologies.
It is in no way a fully feature-complete product, nor is it ever meant to be an actual competitor for the Clear app.

# Requirements

### Cocoa

* Xcode 8.
* CocoaPods 1.0.1.

### Android

* Android Studio 2.2 with Android API 25
* An emulator, Genymotion or a real device attached and running.

## 1. Get the Realm Object Server

The Realm Tasks apps uses a Realm Object Server to synchronize tasks between them.

The fastest way to get access to a Realm Object Server is by signing up for a free Realm Cloud trial:
https://cloud.realm.io/login/sign-up.

## 2. Build and Run RealmTasks

First download or clone this repo.

### Cocoa

1. Run `pod install` from the `RealmTasks Apple` directory in this repo.
2. Open `RealmTasks Apple/RealmTasks.xcworkspace` with Xcode 8.
3. Select either the "RealmTasks macOS" or "RealmTasks iOS" depending on which platform you'd like to try the app on.
4. Click the "Build and Run" icon in the upper left of Xcode (play icon).
5. When the app launches, tap/click "Register" if this is the first time you're trying the app, or "Log In" if you've
already created an account.
6. Optional: If you'd like to run the app on a physical iPhone, you'll need to have code signing set up with Xcode, and
the iPhone should be connected on the same local network as your Mac running the object server.

### Android

1. Go to the `RealmTasks Android` directory in this repo.
2. Run `./gradlew installDebug`
3. The RealmTask app should now be installed on all attached Android devices and emulators. You need to launch the app manually.

### Using RealmTasks

At this point, you can login, start creating items, managing lists, and you'll see your actions reflected in real time in other
running instances of the app wether it is the Android, iOS or macOS app.

We recommend that you run at least two instances of the app together to really show off sync in action.

## 3. Access Realm Files with Realm Studio

Another useful tool is [Realm Studio](https://realm.io/products/realm-studio/) which is available for macOS, Linux, Windows and allows developers to inspect and manage Realms. Realm Studio is recommended for all developers and can be downloaded from the [Realm web site](https://realm.io/products/realm-studio/).

1. Launch the Realm Studio app obtained above and click "Connect to Realm Object Server".
2. Press "Connect" to connect to the Realm Object Server running locally.
3. You now see a list of all Realms on the server. The RealmTask file is named `//realmtasks`.

# Compatibility

RealmTasks is designed to be cross platform, so versions for all platforms/languages should be able to sync with each other. There may be slight discrepancies in terms of functionality which will be listed here.

- Authentication against Azure Active Directory is only supported in the Xamarin version.

# Third Party Dependencies

### Cocoa

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

* [Realm Swift](https://realm.io) - The Swift version of the Realm Mobile Database.
* [Realm LoginKit](https://github.com/realm-demos/realm-loginkit) - A Realm control for logging in to Realm servers.
* [Cartography](https://github.com/robb/Cartography) - A library for making it easier to define auto layout constraints in code.
* [SwiftLint](https://github.com/realm/SwiftLint) - A tool for validating the quality of Swift code.

# Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md) for more details!

This project adheres to the [MongoDB Code of Conduct](https://www.mongodb.com/community-code-of-conduct).
By participating, you are expected to uphold this code. Please report
unacceptable behavior to [[email protected]](mailto:[email protected]).

# License

The source code for RealmTasks is licensed under the [Apache License 2.0](LICENSE).