Demo

Requirements:

Functional

• Fetching and parsing data from API.
• Listing Data.
• Navigation to Details view.
• Search

Non-Functional:

• Scalability:
  • Modularity.
• Performance:
  • Adding debounce to avoid misusing the search APIs.

Diagrams

• High-Level Diagram

• Low-Level Diagram - MVVM with clean architecture

Decisions

• IDE & Deployment target:

  • XCode 15.3
  • Deployment target: 17.2

• UI:

  • UIKit - Programmatic UI
  • MVVM with Clean Architecture (UseCase & Router)

• Principals and Patterns:

  • SOLID conformance:
    • Features are separated into modules.
    • Factory pattern to create each module.
    • Repository for formatting backend data.
    • Shared Repository to manage communication among modules.
    • UseCases for business logic.
    • Router for navigation

• Dependency Manager:

  • Swift Package Manager

• Dependencies:

  Kingfisher: Downloading and caching images from the web.

Important notes

1. Communication among modules is being done using SharedRepository which is being implemented using singleton.
2. Caching is not implemented inside the code cause of the time interval for the task.
3. All print statements are being wrapped inside #if DEBUG to avoid having it printed in production, it's done one time inside an extension.
4. The errors are being printed just for now, Suppose to handle them in functions and dedicated views for each.
5. I didn't focus on the design as was mentioned to be able to finish ASAP.

What could be improved

• Creating caching layer to cache the data.
• Adding pagination for better performance.
• Adding Loading for better UX.
• Be more secure and include the API keys in keychain ot external tool.
• Implement the needed UI formatting in the viewModel not in the View.
• Seperated branch for each feature.
• Unit testing.
• Caching images.
• CI/CD