Skip to content
📚 📱 Reading List - an iOS app to track personal reading lists
Branch: master
Clone or download
AndrewBennet Merge pull request #30 from AndrewBennet/search-online-preview
Add detail button to search online page
Latest commit 61270d5 Apr 22, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Move CONTRIBUTING to .github folder Jan 29, 2019
ReadingList
ReadingList_Foundation
ReadingList_Screenshots
ReadingList_UITests Increment version Apr 12, 2019
ReadingList_UnitTests
fastlane
media
.gitattributes
.gitignore
.swiftlint.yml
.travis.yml
Gemfile Add xcode-install to specify xcode 10 Sep 16, 2018
Gemfile.lock Update fastlane Mar 30, 2019
LICENSE
Mintfile
PRIVACY.md Update PRIVACY.md Jan 17, 2019
Podfile
Podfile.lock
README.md
project.yml

README.md

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 10.2

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.

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

You can’t perform that action at this time.