This project was built with Swift. It is a simple news app that fetches news from the News API and displays them in a list. The user can tap on a news article to view more details about it. On another tab, the user can scroll through its friends list and tap on a friend to view more details about them, including their location on a map.
iPhone15Pro.mov
iPhoneSE.mov
The project was built in the span of 3 days. The first day was spent on setting up the project and creating the tab bar. The second day was spent on fetching the user data and displaying it in a list, and same for the news. The third day was spent on adding the map feature for the users and the details view for the news.
Additionally, some small features were added, such as refresh control, and the hability to tap outside the search bar to dismiss the keyboard.
The project was planned in this Notion Board.
A Mockup was created in Whimsical to guide the development of the project. It can be found here.
The projects needs CocoaPods to run. If you don't have CocoaPods installed, you can install it following these instructions.
After installing CocoaPods, navigate to the project folder in your terminal (you should see a 'Pods' directory inside it) and run pod install. Then, open the NewsMobileApp.xcworkspace file in Xcode and run the project.
The project was built using the MVVM architecture. The ViewModel is responsible for fetching the data from the API and parsing it. The ViewController is responsible for displaying the data and handling user interactions. The Model is responsible for holding the data, and was created with the QuickType tool.
The project uses asynchronous networking to fetch data from the News API.
The project uses Combine to handle the asynchronous networking and to update the UI when the data is fetched.
The project uses the following dependencies:
- GoogleMaps: to display the map with the user's location.
The project is organized by modules. Inside the Modules directory, there are two modules: Posts and Friends. Each module has its own submodules. Each submodule has its own directory with the following structure:
- Model: contains the Model
- View: contains the ViewController
- ViewModel: contains the ViewModel
Along with the submodules, there is a 'Networking' directory that contains the API service.
There's also a 'Common' directory at the same level that 'Modules', that contains the shared resources between the modules such as 'GenericCell' and a UIView extension.
The project has unit tests for each module. The tests are located in the NewsMobileAppTests directory.
The tests coverage is 84.3%.
The project has a branch called 'wip/published-protocol'. This is a work in progress branch that aims to implement a protocol to reuse the friends' list and the news list. The idea is to create a protocol that defines the properties and methods that the viewModels should have, and then make two different viewModels to conform to this protocol, each one for each list.
This way, the ViewController can be reused and the code can be more organized. Eventhough it was cancelled, the work is only missing one function so far on the viewModel's protocol: search(searchText: String), which allows the view to search in the list.
This idea was taking too much time of research and implementation, so I decided to leave it in a separate branch and focus on the main features of the project. Because the project is small, the reuse of the ViewController is not a priority, but it is a good practice to implement it.
The code in this branch was based on the following article: Publishing Updates Using Protocols with Combine on iOS.
The branch still has some commented code (some of it is wrong) and some code that is not working properly. It is not ready to run.
Links that helped me during the development of the project: