Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/alexshepard84/spacex-swiftui-demo

SwiftShowcase: An iOS app that demonstrates modern Swift development with clean architecture. Includes examples of REST and GraphQL API integrations with the SpaceX API, implemented in a modular, testable and maintainable code base.
https://github.com/alexshepard84/spacex-swiftui-demo

clean-architecture clean-code graphql graphql-api graphql-client ios ios-clean-architecture ios-demo ios-swift restful-api spacex-api spacexapi spm swift swift-package-manager swift5 swiftui swiftui-demo swiftui-example

Last synced: about 1 month ago
JSON representation

SwiftShowcase: An iOS app that demonstrates modern Swift development with clean architecture. Includes examples of REST and GraphQL API integrations with the SpaceX API, implemented in a modular, testable and maintainable code base.

Awesome Lists containing this project

README 

        
# SpaceX-SwiftUI-Demo



![AppDemo](https://github.com/alexShepard84/SpaceX-SwiftUI-Demo/assets/63854354/f042a08b-2e71-4236-9c5c-24a10c42c1e8)



## Overview

SwiftShowcase is an iOS application that demonstrates advanced development techniques in Swift and SwiftUI, focusing on both RESTful and GraphQL API integrations. The project adheres to Clean Architecture principles to ensure maintainability, scalability, and separation of concerns.



## Contributions

Feedback, suggestions, and contributions are welcome. Please use GitHub issues and pull requests.



## Objective

This application is designed to showcase:

- Swift and SwiftUI application development

- Implementation of MVVM design pattern within Clean Architecture

- Integration with RESTful and GraphQL APIs

- Local data management using Core Data

- Advanced SwiftUI features and animations

- Unit and UI testing



## Clean Architecture

Clean Architecture involves separating the code into layers, each with its distinct responsibility. This project is structured into:

- **Entities Layer**: Contains the business logic models.

- **Use Cases Layer**: Encapsulates the application-specific business rules.

- **Interface Adapters Layer**: Comprises ViewModels, presenting data to the UI and handling user input.

- **Frameworks and Drivers Layer**: Manages external dependencies and data sources, such as API services and databases.



This layered approach ensures that the application is not only testable and independent of external frameworks but also that business logic and UI are decoupled.



## Features

SwiftShowcase includes:

1. **REST API Integration**: Fetching and displaying data from RESTful services.

2. **GraphQL API Integration**: Handling queries and mutations with GraphQL.

3. **Local Data Storage**: Using Core Data for CRUD operations.

4. **SwiftUI Features**: Implementing UI components.

5. **Testing**: Unit and UI tests to validate code.



## Architecture

The application uses a modular approach with Swift Packages, promoting code reusability and maintainability.



## App Structure



The application is structured into several layers and packages, each with a specific role in the overall architecture. Below is an overview of the main components:



### Domain Layer: `SpaceXDomain` (Swift Package)

- Contains the core business logic and entities (models) of the application.

- Defines interfaces (protocols) for repositories and use cases.



### Data Layer: `SpaceXRestApi` (Swift Package)

- Responsible for data retrieval and persistence.

- Implements the repository interfaces defined in the `SpaceXDomain` package.

- Interacts with external data sources, such as REST APIs.



### Network Service: `NetworkService` (Swift Package)

- A standalone package dedicated to handling network requests.

- Provides a reusable and configurable service for making API calls.



### App Layer

- **DIContainer**: Manages the dependencies of the application, providing a centralized point for object creation and dependency injection.

- **PreviewDIContainer**: A specialized version of `DIContainer` used for SwiftUI previews. It typically provides mock implementations for testing and UI development purposes.



Each layer is designed to be independent and interchangeable, promoting a clean architecture that separates concerns and enhances testability.



## Getting Started

Clone the repository and open the project in Xcode to begin:



```bash

git clone https://github.com/alexShepard84/SwiftShowcase.git

```



## Project Setup



This section guides you through the initial setup process for the SwiftShowcase project.



### Ruby Dependencies and Bundler



This project uses [Bundler](https://bundler.io/) to manage Ruby dependencies, including [CocoaPods](https://cocoapods.org/) and [Fastlane](https://fastlane.tools/).



#### Prerequisites

Ensure you have Ruby installed on your system. The required Ruby version is >= 2.6.3 and <= 3.2.2. You can check your Ruby version with `ruby -v`.



If Bundler is not already installed, install it using:



```bash

gem install bundler

```



#### Installing Dependencies

To install all required Ruby gems, run the following command in the project directory:



```bash

bundle install

```



This will install the gems defined in the `Gemfile`.



#### Using `bundle exec`

To ensure you are using the specific gem versions defined for this project, you should prefix commands with `bundle exec`. For example:



- To run Fastlane lanes, use:



```bash

bundle exec fastlane [lane_name]

```



Using `bundle exec` ensures that you are using the correct versions of the gems set for this project and avoids conflicts with other gem versions that may be installed globally on your system.



### Apollo GraphQL Setup



This project uses Apollo GraphQL for handling GraphQL queries. The setup process is streamlined using a Makefile.



### Installing Apollo GraphQL CLI

The Apollo GraphQL CLI is essential for downloading the GraphQL schema and generating Swift code from GraphQL files. The CLI is installed and managed via the Makefile.



To install the Apollo GraphQL CLI and set up the necessary configurations, run:



```bash

make setup

```



This command performs the following actions:

- Installs the Apollo iOS CLI using Swift Package Manager in the `Packages/Data/SpaceXGraphQL` directory.

- Downloads the latest GraphQL schema based on the configuration in `Packages/Data/SpaceXGraphQL/Apollo/apollo-codegen-config.json`.

- Generates Swift code based on the GraphQL schema and operations defined in the project.



### Updating GraphQL Schema and Code Generation

To update the GraphQL schema or regenerate Swift code after making changes to GraphQL queries or mutations, run the following commands:



```bash

make fetch-schema

make generate

```



### Troubleshooting

If you encounter any issues with the Apollo setup, ensure that:

- The correct GraphQL endpoint and configurations are set in `Packages/Data/SpaceXGraphQL/Apollo/apollo-codegen-config.json`.



For more detailed information about Apollo GraphQL and its CLI, refer to the [Apollo GraphQL documentation](https://www.apollographql.com/docs/).



## Acknowledgments



This project uses several third-party libraries and APIs:



### SpaceX API

Data for this application is sourced from the [SpaceX API](https://github.com/r-spacex/SpaceX-API), an open-source project providing comprehensive SpaceX data.



### Third-Party Libraries

- **SwiftLint**: A tool for enforcing Swift style and conventions. More information can be found at [SwiftLint](https://github.com/realm/SwiftLint).

- **OHHTTPStubs**: A library for testing HTTP requests and responses, available at [OHHTTPStubs](https://github.com/AliSoftware/OHHTTPStubs).

- **ApolloCombine**: A library for integrating GraphQL with Swift's Combine framework, available at [ApolloCombine](https://github.com/joel-perry/ApolloCombine.git).



## Author



**Alex Schäfer**



- GitHub: [alexShepard84](https://github.com/alexShepard84)