smeis/picsojags-ios

The number one app for your daily Jaguar photo fix. The car, not the cat.

Picsojags

Your source of daily Jaguar photos. The car, not the cat.

Hi Joost ;)

Screenshots

Setup

To perform the necessary steps to compile this project, run the following command in the project root:

$ rake setup

Most importantly, it copies the services configration from Config/PhotoServices-sample.plist to Config/PhotoServices.plist.

Minimal manual setup

$ cp ./Config/PhotoServices-sample.plist ./Config/PhotoServices.plist
$ pod install

Assumes tools like cocoapods and Jazzy (for generating docs) are already installed.

Configuration

Important: Add the API keys required for the services you intend to use to Config/PhotoServices-sample.plist. The plist layout is as follows:

- root
|- Services: Dictionary 
  |- 500px: kjdfjhUYERHJ7435438

Note: I don't recommend storing your API keys in you app this way; they're easily accessed by looking through your app's resources. It's just a convenient way to hide keys from git commits in an open-source project, like this.

Adding backends

Adding a backend is as easy as creating a new struct that conforms to PhotoBackend.

Design

Images are created in Sketch. Icons and colors are generated by PaintCode. Check the source files in Design/.

Documentation

Generate the documentation by calling:

$ rake docs

Access the generated code reference by opening Docs/index.html.

Testing

Run the following command from the project root:

$ rake test

Or just press ⌘ + U in Xcode.

Improvements

Comments prefixed with WARN:/TODO:/FIXME: will automatically show up as warnings. Those are great places to start improving.

License

MIT, for details check LICENSE.