ycaihua / xkcd-open-source Goto Github PK

A free, ad-free, open-source, native, and universal xkcd.com reader for iOS. Download it from the app store now!

Architecture

• AFNetworking for networking. duh
• Realm as a data store.
• Façade for the UI layout.
• GTrack for interfacing with Google Analytics.
• SDWebImage for image downloading / caching.
• FLAnimatedImage for that one GIF.
• Fabric for beta distribution, analytics, and crash reporting.
• xkcd-font because obviously.
• Stripped, modified, and customized Mosaic Layout for the comic list.

Todo List (in no specific order)

• Gathering user feedback (ongoing)
• Searching
• Visual indication that comics are read/unread
• Investigate integrating the What If? series (probably not happening for now...)
• Favoriting
• 'Next' and 'prev' movement between comics
• View a random comic
• Social sharing
• Code coverage > 25%
• Code coverage > 50%
• Code coverage > 75%
• Code coverage > 95%
• About section featuring major contributors
• Ask users one-time only to leave a review/rating in the app store, to get some more honest feedback
• Get Randall Munroe to acknowledge my existence

Version History

• v2.1.1 (Submitted to Apple for review)

  • iOS 9 networking bug fix (mamaral#29)

• v2.1 (Available for download in the App Store)

  • Share comics to Facebook and Twitter

• v2.0

  • Added the ability to favorite a comic, which is indicated on the comic list with a pretty red heart. Along with this, you're able to toggle a filter on the comic list to see only favorites
  • Roll-the-dice to view a random comic
  • Navigate forward and backward through comics directly from the comic view controller
  • Fixed a potential issue with comics not loading on the first launch

• v1.2

  • Visual indication that comics are read vs. unread
  • Improved comic view layout so some comics won't be cut off by the alt button
  • Hopefully corrected issue related to disappearing push notifications

• v1.1

  • Improved scrolling performance
  • Search beta
  • Silent push notifications w/ vibration & app badge
  • Bug fixes

• v1.0

  • Initial Release - you can read comics and stuff...

Contributors

• Yours Truly - Architect of the iOS app.
• Sean Ferguson - Architect of the server that pulls content from xkcd and pushes to clients.
• Ryan Copley - CI build improvements.

Want to help?

Download the app and use it - give us feedback! Leave a star on the repo, and a review on the app. If you find any bugs, have any feature requests, or want to say mean and nasty things to me, open an issue, and if you can patch the bug or add a feature and submit a pull request, even better - just make sure to follow the same code formatting/style and BE SURE TO ADD TESTS if applicable.

License / Attribution

The source is made available under the MIT license. See LICENSE.txt for details. For information regarding xkcd licensing, click here.

Social sharing icons from Zlatko Najdenovski via a Creative Commons Attribution 3.0 Unported License.