https://github.com/instacart/formula

A functional reactive framework for managing state and side effects based on RxJava.
https://github.com/instacart/formula

android formula functional-reactive-programming kotlin state-management

Last synced: 4 days ago
JSON representation

A functional reactive framework for managing state and side effects based on RxJava.

• Host: GitHub
• URL: https://github.com/instacart/formula
• Owner: instacart
• License: bsd-3-clause-clear
• Created: 2019-02-21T18:30:17.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-09-17T14:40:53.000Z (about 2 months ago)
• Last Synced: 2024-09-18T04:02:20.006Z (about 2 months ago)
• Topics: android, formula, functional-reactive-programming, kotlin, state-management
• Language: Kotlin
• Homepage: https://instacart.github.io/formula/
• Size: 3.19 MB
• Stars: 149
• Watchers: 9
• Forks: 14
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Formula

A Kotlin framework for managing state and side effects. It is inspired by MVU(model, view, update) 

architecture and best of functional, declarative and reactive patterns. It enables building 

deterministic, composable, testable applications.



[Check documentation](https://instacart.github.io/formula/)

[Check samples](samples)

## Android Module

The Android module provides declarative API to connect reactive state management to Android Fragments. 

This module has been designed for gradual adoption. You can use as much or as little of it as you like.

To learn more, see our [Integration Guide](docs/Formula-Android.md).

## Download

Add the library to your list of dependencies:

```groovy

dependencies {

    implementation 'com.instacart.formula:formula-rxjava3:0.7.1'

    implementation 'com.instacart.formula:formula-android:0.7.1'

}

```

# License

```

The Clear BSD License

Copyright (c) 2022 Maplebear Inc. dba Instacart

All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted 

(subject to the limitations in the disclaimer below) provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

* Neither the name of Maplebear Inc. dba Instacart nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED BY THIS LICENSE. THIS SOFTWARE IS PROVIDED BY 

THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, 

THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 

COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 

DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; 

OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR 

TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 

OF THE POSSIBILITY OF SUCH DAMAGE.

```