Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/HipByte/Flow
Cross-platform libraries for RubyMotion
https://github.com/HipByte/Flow
Last synced: 3 months ago
JSON representation
Cross-platform libraries for RubyMotion
- Host: GitHub
- URL: https://github.com/HipByte/Flow
- Owner: HipByte
- License: bsd-2-clause
- Created: 2015-11-23T13:04:54.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2022-12-01T00:57:16.000Z (almost 2 years ago)
- Last Synced: 2024-04-24T09:03:24.047Z (7 months ago)
- Language: Ruby
- Homepage:
- Size: 7.37 MB
- Stars: 141
- Watchers: 22
- Forks: 29
- Open Issues: 30
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://travis-ci.org/HipByte/Flow)
# Flow
Flow is a set of cross-platform libraries for RubyMotion. It can be seen as RubyMotion's missing standard library.
Each library implements the following requirements:
* Simple Ruby API
* 100% cross-platform (iOS, Android and OS X)
* No external dependencies
* Covered by tests
* [API Documentation](http://www.rubymotion.com/developers/motion-flow/)
**WARNING**: Flow is currently a work in progress. Some specs might be broken, APIs might change, and documentation might be missing. We are working toward a stable release. If you want to help please get in touch.
## Libraries
Flow is currently composed of the following libraries:
* [**UI**](https://github.com/Hipbyte/Flow/tree/master/flow/ui) - User interface framework
* [**Net**](https://github.com/Hipbyte/Flow/tree/master/flow/net) - HTTP networking and host reachability
* [**JSON**](https://github.com/Hipbyte/Flow/tree/master/flow/json) - JSON serialization
* [**Digest**](https://github.com/Hipbyte/Flow/tree/master/flow/digest) - Digest cryptography
* [**Store**](https://github.com/Hipbyte/Flow/tree/master/flow/store) - Key-value store
* [**Base64**](https://github.com/Hipbyte/Flow/tree/master/flow/base64) - Base64 encoding/decoding
* [**Location**](https://github.com/Hipbyte/Flow/tree/master/flow/location) - Location management and (reverse) geocoding
* [**Task**](https://github.com/Hipbyte/Flow/tree/master/flow/task) - Lightweight tasks scheduler
### Installation
`motion-flow` requires RubyMotion >= 4.12. Make sure [iOS](http://www.rubymotion.com/developers/guides/manuals/cocoa/getting-started/) and [Android](http://www.rubymotion.com/developers/guides/manuals/android/getting-started/) are correctly setup.
```
$ gem install motion-flow
```
If you are targeting Android, you need to install the dependencies with Gradle:
```
$ bundle && rake android:gradle:install
```
### Projects
#### Flow projects
Flow comes with its own RubyMotion template, which creates a hybrid (iOS + Android + OS X) project.
```
$ motion create --template=flow Hello
$ cd Hello
$ rake -T
```
#### RubyMotion projects
Flow can be added as a dependency of an existing iOS, Android or OS X RubyMotion project, by adding the `motion-flow` gem in the project's `Gemfile`.
### Code organization
Each Flow library is contained in subdirectories inside the `flow` directory.
Platform-specific code is contained inside subdirectories of each library
(E.g. `cocoa` and `android`).
### Documentation
The documentation is written separately in the `doc.rb` file. If you work on a PR,
please modify this file accordingly.
#### Generate documentation
```
yard
```