kbabis / beerpal Goto Github PK

UIKit · SnapKit · RxSwift · RxCocoa · RxFeedback · Coordinators · PropertyWrappers · NSCache · State management · Rich links · Safe assets · Data binding · Dependencies management · Local storage · Static analysis · Alamofire · XCTest · Reactive extensions

BeerPal is a showcase project that presents my approach to iOS application development with up to date tech-stack, as I am unable to show programs I work on a regular basis.

The app provides a variety of beer-related information through the use of the open BreweryDB API and has been designed from scratch with a strong emphasis on providing the best UX possible.

Briefly, the project consists of:

• 100% Swift
• MVVM + C architecture
• Reactive UI
• CI pipeline
• Testing (Unit, UI)
• Static analysis tools
• Dependency Injection
• Apple Human Interface Guidelines

Deployment target was set to iOS 13.0 as it is installed on 96.5% of devices (as of Oct 20, 2020).

The project takes advantage of many popular platform libraries and each of them is in the stable version.

• External libraries

  • Alamofire - elegant networking
  • SwiftLint - static source code analysis
  • R.swift - safe, strong typed resources
  • SnapKit - well-known DSL that helps in creating UI from code
  • RxSwift - reactive programming in Swift, Combine's forerunner
  • RxCocoa - reactive Cocoa API wrapper containing powerful traits system
  • RxDataSources - bindable complex data sets
  • RxFeedback - handling state in a reactive manner
  • Nuke - efficient image loading and caching system

• Software

  • Xcode 11.4.1, 12.1
  • Sketch
  • Adobe XD

• Core Data local recipe storage
• UIUserInterfaceStyle support
• UI Tests
• Additional brewing calculators

Prerequisites: CocoaPods, Xcode 11.4+

1. Open Terminal.

2. Run following commands:

   git clone https://github.com/crunkz/beerpal
   cd beerpal/Sources/
   pod install
   open BeerPal.xcworkspace/
   

3. Obtain an API key and paste it in /Sources/App/AppConfig.swift.

If you have any questions or suggestions, do not hesitate to reach me out!

MIT License

Copyright (c) 2020 Krzysztof Babis

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and 
associated documentation files (the "Software"), to deal in the Software without restriction, including 
without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 
copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to 
the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial 
portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT 
LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN 
NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, 
WHETHER IN AN ACTION OF  TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE 
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.