Skip to content

📚 📱 Reading List - an iOS app to track personal reading lists

License

Notifications You must be signed in to change notification settings

camjc/ReadingList

 
 

Repository files navigation

Reading List

Build Status codebeat badge

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 11

Dependencies

Reading List uses a couple of package managers:

  • Mint, to manage Swift command line tool packages
  • Bundler, to manage Ruby tools

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

brew install mint
gem install bundler

XcodeGen

The Xcode project should be generated by running XcodeGen:

mint run yonaskolb/XcodeGen

SwiftLint

SwiftLint is used to enforce Swift style guidelines. An Xcode build step runs SwiftLint; this requires it to be installed. To install it, run:

mint install realm/SwiftLint

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.

Example storyboard

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:

Core data entities

About

📚 📱 Reading List - an iOS app to track personal reading lists

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Swift 97.6%
  • Ruby 2.3%
  • Objective-C 0.1%