README.md

Reading List

Reading List is a free, open source iOS app for iPhone and iPad. Reading List allows users to track and catalog the books they read.

Requirements

• Xcode 10.1

Dependencies

Reading List uses a couple of package managers:

• Mint, to manage Swift command line tool packages
• Bundler, to manage Ruby tools
• SwiftLint, to enforce Swift style and conventions

Mint and SwiftLint can be installed using Homebrew (among other methods); Bundler can be installed with RubyGems:

brew install mint
brew install swiftlint
gem install bundler

XcodeGen

The Xcode project should be generated by running XcodeGen:

mint run yonaskolb/XcodeGen

CocoaPods

Reading List uses various third party libraries, which are managed using CocoaPods. To ensure that CocoaPods is installed, run bundler install. To install the libraries, run:

pod install

Architecture

Reading List is written in Swift, and primarily uses Apple provided technologies.

UI

Reading List mostly uses storyboards for UI design (see below); a limited number of user input views are built using Eureka forms.

Data persistence

Reading List uses Core Data for data persistence. There are three entities used in Reading List: Book, Subject and List. The attributes and relations between then are illustrated below: