silvinaroldan / GitHubTrends

Swift app that list trending projects on Github and when tap on one of them it shows their details

GitHubTrends

Swift app that lists trending projects on Github and when tap on one of them it shows their details.

Getting Started

This project makes use of cocoapods as a dependency manager for third party libraries used in the project.

As is requested, I'm using MVVM pattern. I also use Coordinator pattern for navigation.

I'm using Swift 5.x as the language for development.

I'm using SwiftLint tool to enforce some style and conventions.

Prerequisites

What things you need to install the software:

1. Development IDE - XCode 10.2 +

2. Operating System - macOS Mojave 10.14.3

3. Dependency manager - Cocoapods

Support levels

1. Deployment Target - iOS 12.2

Project setup

Steps to get the project ready:

1. Install cocoapods (sudo gem install cocoapods).

2. Once cocoapods is installed in your machine, go to Project directory and Run "pod install".

Xcode Configurations

I added an "API_BASE_URL" and a "DEBUG_ALERTS" user defined configuration on Build Settings to manage the defaults release and debug environments as is described here. Since this is not a production project I didn't add other schemas.

Note:

From what I see, there is no official GitHub API to get a list of trending repositories. As is suggested here I list the trendy repositories using the Search Github API to get the most starred repositories.