基于RxSwift和MVVM-C清晰架构的GitHub iOS客户端。
内容
截图
思维导图(完整版)
## 应用功能 - [x] 基本、个人访问令牌和OAuth2身份验证 - [x] 查看热门仓库和用户([github-trending-api](https://github.com/huchenme/github-trending-api)) - [x] 高级搜索和排序仓库和用户,按语言筛选 - [x] 查看仓库和用户详情、事件、问题、提交、拉取请求、贡献者等 - [x] 查看问题和拉取请求消息([MessageKit](https://github.com/MessageKit/MessageKit)) - [x] GitHub仓库代码行数统计工具([codetabs](https://github.com/jolav/codetabs))([Charts](https://github.com/danielgindi/Charts)) - [x] GitHub仓库缺失的星标历史图表([stars-history](https://github.com/timqian/star-history)) - [x] 快速浏览任何Git仓库中文件的历史([git-history](https://github.com/pomber/git-history)) - [x] GitHub个人资料可视化工具([profile-summary-for-github](https://github.com/tipsy/profile-summary-for-github)) - [x] 查看GitHub贡献图的3D模型([skyline](https://skyline.github.com)) - [x] 源文件查看器和语法高亮([Highlightr](https://github.com/raspu/Highlightr)) - [x] 浅色和深色模式下的颜色主题([RxTheme](https://github.com/RxSwiftCommunity/RxTheme)) - [x] 应用内语言切换(英语、中文、俄语、亚美尼亚语)([Localize-Swift](https://github.com/marmelroy/Localize-Swift)) - [x] 新功能介绍([WhatsNewKit](https://github.com/SvenTiigi/WhatsNewKit)) - [x] 邀请好友功能 - [x] 支持iPhone和iPad(分屏视图) - [ ] 直接将仓库克隆到应用([SwiftGit2](https://github.com/SwiftGit2/SwiftGit2))技术
- 清晰架构(RxSwift和MVVM)
- 流程协调器(Realm演示)
- REST API v3(用于未认证或基本认证)(Moya,ObjectMapper)
- GraphQL API v4(用于OAuth2认证)(Apollo)
- 自定义转场动画(Hero)
- 程序化UI(SnapKit)
- Mixpanel和Firebase分析事件(Umbrella)
- 崩溃报告(Crashlytics)
- 日志记录(CocoaLumberjack)
- Google广告实现,可在设置中启用/禁用(Firebase AdMob)
- 迁移到Apple的新SwiftUI和Combine
- 依赖注入(Swinject)
- 添加测试
工具
- Brew - macOS 缺失的包管理器
- Bundler - 管理 Ruby 应用程序的 gem 依赖
- Fastlane - 自动构建和发布 iOS 和 Android 应用的最简单方法
- SwiftLint - 强制执行 Swift 代码风格和规范的工具
- Jazzy - Swift 和 Objective-C 的优雅文档生成工具
- JSONExport - 一个可以将 JSON 对象导出为模型类的桌面应用
- R.swift - 在 Swift 项目中获取强类型、自动补全的资源,如图片、字体和 segue
- Flex - iOS 应用内调试和探索工具
- Sourcetree - 适用于 Windows 和 Mac 的免费 Git 客户端
- Postman - 用于测试 Web 服务的强大 HTTP 客户端(查看)
- Sketch - Mac 平台的数字设计应用(付费)(查看)
- iThoughtsX - 适用于 Windows、Mac、iPad 和 iPhone 的思维导图应用(付费)(查看)
构建和运行
在开始之前,你需要准备一些东西。 确保你已经从 App Store 安装了 Xcode。 然后运行以下命令安装 Xcode 的命令行工具(如果你还没有安装的话):
xcode-select --install
安装 Bundler
来管理 Ruby gem 依赖:
[sudo] gem install bundler
安装 macOS 的 Brew 包管理器:
对于 MacOS Catalina、macOS Mojave 和 MacOS Big Sur:
/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
对于 macOS High Sierra、Sierra、El Capitan 及更早版本:
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)"
brew install node
以下命令将设置 SwiftHub:
cd SwiftHub
bundle install
bundle exec fastlane setup
要更新所有工具和 pods,请运行:
bundle exec fastlane update
好了!我们准备就绪了!
文档
你可以在本地生成 API 文档。在此仓库的根目录运行 jazzy
。这需要安装 jazzy。你可以在 docs/
目录中找到生成的输出。你可以在配置文件 .jazzy.yaml 中设置项目文档的选项。
调试
本应用集成了 Flex 调试工具。要启用它,只需在应用中向右滑动即可。 此外,还包含了 Hero 动画的调试功能。要使用它,请用两根手指向右滑动。重复此操作可禁用。
Fastlane
Fastlane 可自动化常见的开发任务,例如更新版本号、在多个配置上运行测试或提交到 App Store。你可以使用 bundle exec fastlane lanes
列出可用的 lane(我们项目特定的脚本)。你可以使用 bundle exec fastlane actions
列出可用的操作(所有可通过 lane 脚本执行的操作)。Fastlane 的配置和脚本位于 fastlane
文件夹中。
设计
应用中使用的所有图标均来自 Feather。 感谢他们提供的漂亮的开源图标。
SwiftHub 收录于
- open-source-ios-apps - 开源iOS应用collaborative列表
- fantastic-ios-architecture - 更好的iOS应用结构方法
- Moya - 社区项目
- MessageKit - 使用此库的应用
- github-trending-api - 使用此库的项目
- awesome-rxswift - RxSwift库和学习资料的精选列表
- Medium-Mybridge - 过去一个月的Swift开源项目(2019年5月版)
- alternativeto - 众包软件推荐
参考资料
- CleanArchitectureRxSwift - 使用RxSwift的清洁架构
- View Model in RxSwift - 优质文章
另请参阅
- GitHawk - 最佳iOS版GitHub应用
- CodeHub - 使用Xamarin编写的iOS应用
- GitPoint - 口袋中的GitHub
- DevHub - GitHub版TweetDeck - 支持Android、iOS、Web和桌面
- OpenHub - 开源GitHub Android客户端应用,更快速简洁
- Trailer - 管理GitHub和GitHub Enterprise的Pull Request和Issue
- FastHub - FastHub,终极GitHub Android客户端
许可证
MIT许可证。查看 LICENSE。