Swift Other
Switch branches/tags
Clone or download
Permalink
Failed to load latest commit information.
.fastlane Add DripAlpha app ID to match (#377) Jun 20, 2018
.github add PR template (#177) Jun 8, 2017
Configs Removed HelpCenter example url (#366) May 30, 2018
Design Remove old design assets (#286) Jan 2, 2018
Frameworks Password reveal functionality (#368) May 31, 2018
Kickstarter-iOS.playground Updated to methods changes (#334) Apr 23, 2018
Kickstarter-iOS Facebook disclaimer copy update (#376) Jun 19, 2018
Kickstarter.xcodeproj Thankyou card bug fix (#374) Jun 12, 2018
KsApi Environment switcher improvement (#370) Jun 13, 2018
Library Facebook disclaimer copy update (#376) Jun 19, 2018
LiveStream Swift4 project update (#309) Feb 27, 2018
Screenshots/_64 Facebook disclaimer copy update (#376) Jun 19, 2018
bin Generalize currency conversion (#231) Aug 31, 2017
hooks Alpha build (#361) Jun 1, 2018
.gitattributes No need to treat pbxproj as a binary. Jun 27, 2016
.gitignore Fastlane tweaks (#338) Apr 24, 2018
.gitmodules Update iOSSnapshotTestCase (#301) Jan 23, 2018
.swiftlint.yml Swiftlint record mode rule (#353) May 10, 2018
Gemfile Swift 4.1 updates, CircleCI 2.0 migration (#331) Apr 19, 2018
Gemfile.lock Swift 4.1 updates, CircleCI 2.0 migration (#331) Apr 19, 2018
LICENSE Replace template text (#181) Jun 13, 2017
Makefile Alpha build (#361) Jun 1, 2018
NOTICE.md Add licenses for more third-party dependencies (#237) Sep 12, 2017
Opentok.lock Swift 4.1 updates, CircleCI 2.0 migration (#331) Apr 19, 2018
README.md Add description for the mock version (#316) Mar 7, 2018
circle.yml Bring back swiftlint build phase, cleanup for automatic alpha builds (#… Jun 1, 2018

README.md

Kickstarter for iOS

Circle CI

Welcome to Kickstarter’s open source iOS app! Come on in, take your shoes off, stay a while—explore how Kickstarter’s native squad has built and continues to build the app.

We’ve also open sourced our Android app, and read more about our journey to open source here.

Kickstarter for iOS

Getting Started

  1. Download the Xcode 9 release.
  2. Clone this repository.
  3. Run make bootstrap to install tools and dependencies.
  4. Run make test-all to build and run tests on all platforms.

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

Some fun things to explore

If you’re just looking for a quick glance at a few things we’re particularly proud of, look no further:

  • The Screenshots directory holds nearly 500 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 , or a creator looking at their dashboard in German and on an iPad here.

  • We use Swift Playgrounds for iterative development and styling. Most major screens in the app get a corresponding playground where we can see a wide variety of devices, languages and data in real time. Browse our collection of playgrounds here.

  • We use view models as a lightweight way to isolate side effects and embrace a functional core. We write these as a pure mapping of input signals to output signals, and test them heavily, including tests for localization, accessibility and event tracking.

Documentation

While we’re at it, why not share our docs? Check out the native docs we have written so far for more documentation.

Dependencies

We make heavy use of the following projects, and so it can be helpful to be familiar with them:

1st party

  • Circle CI Prelude: Foundation of types and functions we feel are missing from the Swift standard library.

  • Circle CI ReactiveExtensions: A collection of operators we like to add to ReactiveCocoa.

3rd party

Notices for 3rd party libraries in this repository are contained in NOTICE.md.

Contributing

We intend for this project to be an educational resource: we are excited to share our wins, mistakes, and methodology of iOS development as we work in the open. Our primary focus is to continue improving the app for our users in line with our roadmap.

The best way to submit feedback and report bugs is to open a GitHub issue. Please be sure to include your operating system, device, version number, and steps to reproduce reported bugs. Keep in mind that all participants will be expected to follow our code of conduct.

Code of Conduct

We aim to share our knowledge and findings as we work daily to improve our product, for our community, in a safe and open space. We work as we live, as kind and considerate human beings who learn and grow from giving and receiving positive, constructive feedback. We reserve the right to delete or ban any behavior violating this base foundation of respect.

Find this interesting?

We do too, and we’re hiring!

License

Copyright 2018 Kickstarter, PBC.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.