Redux icon indicating copy to clipboard operation
Redux copied to clipboard

Swift implementation of Redux

Redux

CI Status codecov.io Version License Platform

Redux is a swift implementation of redux.

A thorough walk through and description of the framework can be found at the official Redux repository: redux.

Features

  • Project scaffolding, includes basic redux structure and test cases
  • File templates
  • Static typed State
  • Handy functions for integrating with UIViewController, similar to react-redux

Getting Started

Quick Start from Project Template

Start with our project template

curl https://raw.githubusercontent.com/oursky/Redux-Project-Template/master/download | bash -s YOUR_PROJECT_NAME

Add to an existing project with CocoaPods

Add the following in Podfile

source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '8.0'

pod "Redux", "~> 0.1.0"

Then, run the following command

pod install

Install Xcode Redux File Templates

Run the following command

# if your XCode path is '/Applications/Xcode.app'
curl https://raw.githubusercontent.com/oursky/Redux-Project-Template/file-templates/install-template.sh | bash -s

# else
curl https://raw.githubusercontent.com/oursky/Redux-Project-Template/file-templates/install-template.sh | bash -s YOUR_XCODE_PATH

Then, you may open Xcode, go to File -> New -> File..., you should be able to find the file templates under Redux

See https://github.com/oursky/Redux-Project-Template/tree/file-templates

Try Example

git clone [email protected]:oursky/Redux.git
cd Redux
pod install --project-directory=Example
open Example/Redux.xcworkspace

Then you may run Redux-Example in XCode

Credit

Inspired from

  • https://github.com/rackt/redux
  • https://github.com/mwise/Redux.swift

License

Redux is available under the MIT license. See the LICENSE file for more info.