yuyusdark / swifthub

Github iOS client written in RxSwift and MVVM clean architecture

Open source Github iOS client written in RxSwift and MVVM architecture.

Screenshots

     

Features

• Basic authentication
• Clean architecture (RxSwift and MVVM)
• Flow coordinators
• Networking (Moya)
• Custom transition animations (Hero)
• Color themes in Light and Dark modes (RxTheme)
• Programmatically UI (SnapKit)
• In-app language switching (en, zh, ru, hy) (Localize-Swift)
• Support iPhone and iPad (Split View)
• Mixpanel and Firebase analytics events (Umbrella)
• Crash reporting (Crashlytics)
• Whats New (WhatsNewKit)
• Logging (CocoaLumberjack)
• App Store application
• OAuth2 authentication
• Dependency injection (Swinject)
• Add tests

Building and Running

You'll need a few things before we get started. Make sure you have Xcode installed from the App Store. Then run the following two commands to install Xcode's command line tools and bundler, if you don't have that yet.

[sudo] gem install bundler
xcode-select --install

The following commands will set up SwiftHub.

cd SwiftHub
bundle install
bundle exec fastlane setup

Try pod update if you got some errors. Alrighty! We're ready to go!

Debugging

Flex debugging tool has been integrated in this application. To enable it, just swipe right anywhere in the application. There are also included debugging Hero animations. To use it, swipe right with two fingers. Repeat this to disable.

Fastlane

Fastlane automates common development tasks - for example bumping version numbers, running tests on multiple configurations, or submitting to the App Store. You can list the available lanes (our project-specific scripts) using bundle exec fastlane lanes. You can list available actions (all actions available to be scripted via lanes) using bundle exec fastlane actions. The fastlane configuration and scripts are in the fastlane folder.

Design

All icons used in the application are taken from the Feather. Thanks to them for the beautiful open source icons.

References

• Moya - Network abstraction layer
• JSONExport - Export JSON objects as model classes
• CleanArchitectureRxSwift - Clean architecture with RxSwift
• View Model in RxSwift - Good article

License

MIT License. See LICENSE.