/eidolon

The Artsy Auction Kiosk App

Primary LanguageSwiftMIT LicenseMIT

Eidolon

The upcoming Artsy Auction Kiosk App.

Project Status

This project is in the very early stages. Its goal is to provide a seamless experience for browsing and bidding on artworks in an auction.

Downloading the Code

Git repositories can be fickle things. Since CocoaPods' support of Swift-based pods is still under construction, we are choosing to – well, forced, really – to use git submodules.

Git Submodules

That means that clicking the "Download ZIP" button isn't going to download all of the code you'll need to run the app. Instead, clone the repository from GitHub by typing the following command.

We'll aslso ask for keys to get the app set up, you can just put gibberish in there if you don't work for artsy.

git clone https://github.com/artsy/eidolon.git
cd eidolon
make bootstrap

Due to an issue with ReactiveCocoa, you need to manually open the ReactiveCocoa project in the workspace and change the iOS target's deployment target to 8.0.

A lot of iOS code still exists as Objective-C, and we use a lot of it as CocoaPods. So after cloning the repo, shown above, you'll need to do a pod install. You'll need to have CocoaPods already installed.

Alrighty! We're ready to go!

Getting Started

Now that we have the code downloaded, we can run the app using Xcode 6. Make sure to open the Kiosk.xcworkspace workspace, and not the Kiosk.xcodeproj project. Currently, the project is compatible with Xcode 6 only, as it's swift.

The Artsy API is private, making it difficult for open source developers to run the app. Once we integrate networking support, we'll figure out a way to stub network requests so that the app can run with sample data.

Artsy has licensed fonts for use in this app, but due to the terms of that license, they are not available for open source distribution. This has required us to use private pods. The Podfile has the differences dealt with.

Contributing

This project is being developed by Artsy primarily for its use as Artsy's auction kiosk app, and we are not expecting to have significant community contributions back to it. We are developing this project in the open because it is not part of our core IP, and open source is part of our job. However, if you notice something that is wrong or could be improved, don't hesitate to send us a pull request.