https://github.com/nazmulkp/clean-architecture-swiftui-mvvm

SwiftUI sample app using Clean Architecture. Examples of working with local and remote data, dependency injection, unit testing, and more.
https://github.com/nazmulkp/clean-architecture-swiftui-mvvm

clean-architecture dependency-injection ios modularity mvvm mvvm-architecture swift swiftui

Last synced: about 2 months ago
JSON representation

SwiftUI sample app using Clean Architecture. Examples of working with local and remote data, dependency injection, unit testing, and more.

• Host: GitHub
• URL: https://github.com/nazmulkp/clean-architecture-swiftui-mvvm
• Owner: nazmulkp
• Created: 2024-06-20T03:43:08.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-06-20T06:05:07.000Z (8 months ago)
• Last Synced: 2024-11-05T13:30:03.721Z (3 months ago)
• Topics: clean-architecture, dependency-injection, ios, modularity, mvvm, mvvm-architecture, swift, swiftui
• Language: Swift
• Homepage:
• Size: 79.1 KB
• Stars: 4
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Clean Architecture and SwiftUI Modular Project

## Overview

ExampleMVVM is an iOS application designed with Clean Architecture principles and SwiftUI modularity. This project demonstrates a scalable, maintainable, and testable architecture, leveraging dependency injection, protocol-oriented programming, and clear separation of concerns.

## Project Structure

The project is organized into distinct layers, each responsible for specific concerns:

- **App**: Entry point and application lifecycle management.

- **Presentation**: UI components and view models.

- **Domain**: Business logic and use cases.

- **Data**: Data sources and repositories.

- **Infrastructure**: Configuration, network, and utilities.

### Directory Layout



## Layer Responsibilities

### App

**ExampleMVVMApp.swift**: Entry point of the application, responsible for setting up the main window and initializing the dependency injection.

### Presentation

**View**: Contains SwiftUI views responsible for the UI layout and presentation.

- **WeatherView.swift**: Main view displaying weather information.

- **WeatherRowView.swift**: Subview displaying individual weather data items.

**ViewModel**: Contains view models that manage UI state and interact with the domain layer.

- **WeatherViewModel.swift**: View model for managing weather data presentation logic.

### Domain

**Interfaces**: Defines protocols for repositories and data sources, ensuring a clear contract between layers.

- **WeatherDataSource.swift**: Protocol for weather data sources.

- **WeatherRepository.swift**: Protocol for weather repositories.

**UseCases**: Contains business logic and application-specific rules.

- **FetchWeatherUseCase.swift**: Use case for fetching weather data.

**Entities**: Contains business models representing core domain objects.

- **Weather.swift**, **City.swift**, **Temperature.swift**: Domain models for weather data.

### Data

**Remote**: Contains data sources for fetching data from remote APIs.

- **RemoteWeatherDataSource.swift**: Implementation of weather data source using remote APIs.

**Local**: Contains data sources for fetching data from local files.

- **LocalWeatherDataSource.swift**: Implementation of weather data source using local JSON files.

**Repositories**: Coordinates between data sources and domain layer, transforming data as needed.

- **WeatherRepositoryImpl.swift**: Implementation of weather repository.

### Infrastructure

**Network**: Manages network communication details.

- **APIClient.swift**: Handles HTTP requests and responses.

- **HTTPMethod.swift**: Enum for HTTP methods.

- **WeatherAPIConfiguration.swift**: Constructs URLs for API endpoints.

**Configuration**: Manages application configurations.

- **AppConfiguration.swift**: Implementation of configuration protocol.

**Utilities**: Contains shared utilities and helpers.

- **JSONLoader.swift**: Utility for loading JSON from local files.

**Interfaces**: Defines protocols for infrastructure components.

- **JSONLoaderProtocol.swift**: Protocol for JSON loader.

- **APIClientProtocol.swift**: Protocol for API client.

- **ConfigurationProtocol.swift**: Protocol for configuration.

## Dependency Injection

The project leverages dependency injection to manage dependencies between layers. This ensures loose coupling and enhances testability. Dependencies are injected through initializers, allowing for easy substitution of implementations during testing.

### Example Initialization

```swift

import SwiftUI

@main

struct ExampleMVVMApp: App {

    var body: some Scene {

        WindowGroup {

            let apiClient = APIClient()

            let appConfiguration = AppConfiguration()

            let apiConfiguration = WeatherAPIConfiguration(configuration: appConfiguration)

            let remoteDataSource = RemoteWeatherDataSource(apiClient: apiClient, apiConfiguration: apiConfiguration)

            

            let jsonLoader = JSONLoader()

            let localDataSource = LocalWeatherDataSource(jsonLoader: jsonLoader, configuration: appConfiguration)

            

            let useLocalData = false // Change this to true to use local data

            let dataSource: WeatherDataSource = useLocalData ? localDataSource : remoteDataSource

            

            let repository = WeatherRepositoryImpl(dataSource: dataSource)

            let fetchWeatherUseCase = FetchWeatherUseCase(repository: repository)

            let viewModel = WeatherViewModel(fetchWeatherUseCase: fetchWeatherUseCase)

            

            WeatherView(viewModel: viewModel)

        }

    }

}

```