Skip to content

Commit

Permalink
Updates readme to reflect platform changes.
Browse files Browse the repository at this point in the history
  • Loading branch information
msadoon committed Feb 22, 2023
1 parent 29008cd commit 2668712
Showing 1 changed file with 17 additions and 10 deletions.
27 changes: 17 additions & 10 deletions README.md
Expand Up @@ -12,9 +12,8 @@ and read more about our journey to open source [here](https://kickstarter.engine

## Getting Started

1. Install Xcode.
1. Clone this repository.
1. Run `make bootstrap` to install tools and dependencies.
1. Install Xcode. We currently support up to XCode 13.4.1.
2. Clone this repository.

* To provide a mock version that serves up hard-coded data immediately, set `KsApi.Secrets.isOSS` = `true`.

Expand All @@ -23,13 +22,12 @@ and read more about our journey to open source [here](https://kickstarter.engine
If you’re just looking for a quick glance at a few things we’re particularly
proud of, look no further:

* The [`Screenshots`](https://github.com/kickstarter/ios-oss/tree/main/Screenshots/_64)
directory holds nearly 500 screenshots of various screens in every language,
* The snapshots directory is location in each feature folder of `Kickstarter-Framework-iOS` and together holds nearly 600 screenshots of various screens in every language,
device and edge-case state that we like to make sure stays true. For example,
a backer viewing a project in French
[here](https://github.com/kickstarter/ios-oss/blob/d33bfbff8dee212eb46328cfcfe64f5aa90afc7b/Screenshots/_64/Kickstarter_Framework_iOSTests.ProjectPamphletContentViewControllerTests/testBacker_LiveProject_lang_fr_device_phone4_7inch%402x.png)
a backer viewing a project in Japanese
[here](https://github.com/kickstarter/ios-oss/blob/main/Kickstarter-iOS/Features/ProjectPage/Controller/__Snapshots__/ProjectPageViewControllerTests/testLoggedIn_Backer_LiveProject_NonUS_ProjectCurrency_US_ProjectCountry_NonUS_UserChosenCurrency_NotOmittingCurrencyCode_Success.lang_ja_device_pad.png)
, or a creator looking at their dashboard in German and on an iPad
[here](https://github.com/kickstarter/ios-oss/blob/64f79ce6a03a8fad9b7024a43c17b4ae5f264d31/Screenshots/_64/Kickstarter_Framework_iOSTests.DashboardViewControllerTests/testView_lang_de_device_pad%402x.png).
[here](https://github.com/kickstarter/ios-oss/blob/main/Kickstarter-iOS/Features/Dashboard/Controller/__Snapshots__/DashboardViewControllerTests/testView.lang_de_device_pad.png).

* [We use view models](https://www.youtube.com/watch?v=EpTlqx6NjYo) as
a lightweight way to isolate side effects and embrace a functional core. We
Expand Down Expand Up @@ -67,8 +65,17 @@ A collection of operators we like to add to ReactiveCocoa.
### 3rd party

* [AlamofireImage](https://github.com/Alamofire/AlamofireImage)
* [FBSnapshotTestCase](https://github.com/facebook/ios-snapshot-test-case)
* [SnapshotTesting](https://github.com/pointfreeco/swift-snapshot-testing)
* [Apollo](https://github.com/apollographql/apollo-ios)
* [Stripe](https://github.com/stripe/stripe-ios)
* [KingFisher](https://github.com/onevcat/Kingfisher)
* [SwiftSoup](https://github.com/scinfu/SwiftSoup)
* [Optimizely](https://github.com/optimizely/swift-sdk)
* [Facebook](https://github.com/facebook/facebook-ios-sdk)
* [Firebase](https://github.com/firebase/firebase-ios-sdk)
* [ReactiveSwift](https://github.com/ReactiveCocoa/ReactiveSwift)
* [AppCenter](https://github.com/microsoft/appcenter-sdk-apple)
* [Appboy](https://github.com/Appboy/Appboy-segment-ios)

Notices for 3rd party libraries in this repository are contained in
`NOTICE.md`.
Expand All @@ -95,7 +102,7 @@ behavior violating this base foundation of respect.

## Find this interesting?

We do too, and we’re [hiring](https://www.kickstarter.com/jobs?ref=gh_ios_oss)!
We do too, and we’re [hiring](https://www.kickstarter.com/jobs)!

## License

Expand Down

0 comments on commit 2668712

Please sign in to comment.