Heroes App 📱

Heroes App is a Swift-based iOS application built using TCA architecture. The app displays a list of Heroes with their details and allows search Heroes by their names.

Features

📜 List of Heroes: Displays a List of all Heroes with their name, Image, and description.
🔍 Search: Search Heroes by their names.
🧍‍♂️ Hero Details: View detailed information about a selected hero, including:
- Name
- Image
- Full description
- Comics
- Series
- Stories

App Screenshots

Heroes List	Heroes Details

How It Works

1. Main View

The main screen is a table view displaying all heroes fetched from the API.

Each row displays:
- hero's name.
- hero's image.
- hero's short description.

2. Hero Details

On selecting a hero from the list, a detail view is shown with the character's:

Profile image.
Name.
Description.
Comics.
Series.
Stories.

Setup & Installation

Clone the Repository

git clone https://github.com/knight6700/WallaMarvel

Install all dependancies with Gem
- Open Terminal
- cd project-path
- make onBoarding
- Write private and public keys Api for Debug and Release
Install Dependencies
- make resolve .
Open in Xcode
- Open the .xcodeproj
Run the App
- Select a simulator or a connected device.
- Click the Run button or press ⌘R.

🔐 Note: For production builds, you can update the API keys via GitHub Secrets or your CI/CD environment.

Make File

To get help on available commands, run: make help Available targets: onBoarding - Run onboarding setup (should be run first) lint - Run SwiftLint with autofix lintReport - Generate SwiftLint HTML report build - Build the WallaMarvel app test - Run MarvelCoreTests snapshotTest - Run MarvelSnapshotTests clean - Clean build and cache artifacts resolve - Reset and resolve Swift packages in MarvelCore generatePackage - Inject Package.yaml into Package.swift help - Show this help message

Package Configuration

This project uses a Package.yaml file for package configuration. Do not modify Package.swift directly as it is auto-generated.

Workflow:

Make changes in Package.yaml
Run command:
```
make generatePackage
```
This will automatically generate the updated Package.swift file.

Example Modifications:

Adding a New Target:

- name: NewFeature
  type: target
  dependencies:
    - ComposableArchitecture
    - HorizonNetwork
  resources:
    - Resources/FeatureAssets.xcassets

Adding a Test Target:

- name: NewFeatureTests
  type: testTarget
  dependencies:
    - NewFeature
    - SnapshotTesting

Available Dependencies Reference:

dependencies:
  - TCADependency      # ComposableArchitecture
  - snapshotTesting    # SnapshotTesting
  - kingFisher         # Kingfisher
  - horizonKeys        # HorizonKeys
  - horizonComponent   # HorizonComponent
  - NETWORK            # HorizonNetwork

Important Notes:

Maintain Swift version compatibility (6.0+)
Verify platform requirements (iOS 17+/macOS 12+)
The make generatePackage command must be run after any Package.yaml changes
Generated Package.swift

Architecture Overview

The app adopts TCA (The Composable Architecture) to structure features in a modular, testable, and scalable way, following principles of unidirectional data flow and state management.

Git Workflow

We use GitFlow to manage our development process. The main branches include:

main: Production-ready code.
develop: Ongoing development and integration.
feature/*: New features are developed here and then merged into develop.
hotfix/*: For urgent fixes on main.

Git Workflow Summary

main ← hotfix/*
↑
develop ← feature/*

Always create branches from develop for new features and from main for hotfixes.

Modules

The project is organized into multiple Swift modules to ensure separation of concerns and modular scalability:

Heroes
- Manages everything related to hero listing and details.
- Includes:
  - Hero List view.
  - Hero Details view.
  - Coordinator logic for navigation between these screens.
HorizonComponents
- Contains all reusable UI components.
- Encourages UI consistency and code reusability across the app.
HorizonNetwork
- Handles all remote API communications.
- Includes:
  - API client.
  - Endpoint configuration.
  - Network error handling.

Diagrams

App Graph:

graph TD
    subgraph "Feature Layer"
        Store[Store]
        Action[Action]
        State[State]
        Reducer[Reducer]
        
        Store --> Reducer
        Action --> Reducer
        Reducer --> State
    end
    
    subgraph "Domain Layer"
        UseCase[UseCase]
        Repository[Repository]
        Mapper[Mapper]
        
        UseCase --> Repository
        UseCase --> Mapper
    end
    
    subgraph "Data Layer"
        RemoteDataSource[Remote Data Source]
        LocalCache[Local Caching]
        
        Repository --> RemoteDataSource
        Repository --> LocalCache
    end
    
    %% Layer interactions
    Store -.-> UseCase
    UseCase -.-> Store
    
    %% Styling
    classDef featureLayer fill:#e3f2fd,stroke:#1976d2,stroke-width:2px
    classDef domainLayer fill:#f3e5f5,stroke:#7b1fa2,stroke-width:2px
    classDef dataLayer fill:#e8f5e8,stroke:#388e3c,stroke-width:2px
    
    class Store,Action,State,Reducer featureLayer
    class UseCase,Repository,Mapper domainLayer
    class RemoteDataSource,LocalCache dataLayer

TCA:

for more details

Key Improvements

Grid View or CollectionVieew: Create a Grid View or CollectionView to efficiently display resources (e.g., comics).
Encryption Module: Implement an encryption module using the Arkana library and MD5, or any other suitable encryption technique.
Network: remore static func for remote.

Dependencies

SwiftUI: For building the UI.
URLSession: For API communication.
Kingfisher: For image downloading and caching.
Snapshot-Testing: For snapshot views.
Netfox: For debugging network requests.
TCA Framework: A Swift framework for managing state, side effects, and app architecture in a modular and testable way
IdentifiedCollections: When modeling a collection of elements in your application's state, it is easy to reach for a standard Array.
swift-dependencies: A dependency management library inspired by SwiftUI's "environment.".

API Integration

The app fetches data from the Marvel API.

Endpoints

🔗 Marvel API Authentication

To fetch characters from the Marvel API, use the following URL format:

https://gateway.marvel.com/v1/public/characters?limit={Int}&offset={Int}&ts={Int}&apikey={String}&hash={String}

🧩 Required Parameters

Parameter	Description
`limit`	Number of results to return.
`offset`	Pagination offset.
`ts` (timestamp)	A unique timestamp. Usually the current time in seconds: `String(Int(Date().timeIntervalSince1970))`
`apikey`	Your public API key from Marvel Developer Portal.
`hash`	An MD5 hash of: `timestamp + privateKey + publicKey` For example: `"\(timestamp)\(privateKey)\(publicKey)"` hashed using MD5.
`privateKey`	Your private API key (keep this secret). Available after registering on Marvel Developer Portal.
`name` (Optional)	Name of the hero you want to search for.

🔐 Hash Generation (Swift Example)

let timestamp = String(Int(Date().timeIntervalSince1970))
let input = "\(timestamp)\(privateKey)\(publicKey)"
let hash = input.md5() // Use an MD5 hashing function

✅ The hash is required for authenticating API requests and must be computed for every call.

Fetch All Characters
- URL: https://gateway.marvel.com/v1/public/characters?limit={Int}&offset={Int}&ts={Int}&apikey={String}&hash={String}
Character Search
- URL: https://gateway.marvel.com/v1/public/characters?limit={Int}&offset={Int}&ts={Int}&apikey={String}&hash={String}&name={String}
Fetch Resources
- URL: https://gateway.marvel.com/v1/public/characters/{character_Id}/{resourceType}?limit={Int}&offset={Int}&ts={Int}&apikey={String}&hash={String}
- Resource Type: comics, series, or stories.

Future Enhancements

🌎 Connectivity Check: Show a "No Internet" alert automatically when the device is offline.
🔥 Caching: Implement API caching using an appropriate technique to improve performance and reduce network usage.
📊 Statistics: Displays statistics for the heroes fetched through the details and search features.

Issues

Duplicated Id: The API was returning duplicate heroes with the same ID, so we resolved it by using a unique id (generated with UUID().uuidString) alongside the original heroId (Int) from the API.

Contributing

Contributions are welcome! Follow these steps to contribute:

Fork the repository.
Create a feature branch:
```
git checkout -b feature-branch
```
Commit your changes:
```
git commit -m "Add new feature"
```
Push to the branch:
```
git push origin feature-branch
```
Create a pull request.

License

This project is licensed under the Creative Commons Attribution-NonCommercial 4.0 International License.

You may not use the material for commercial purposes.

Name		Name	Last commit message	Last commit date
Latest commit History 182 Commits
.github		.github
MarvelCore		MarvelCore
WallaMarvel.xcodeproj		WallaMarvel.xcodeproj
WallaMarvel		WallaMarvel
WallaMarvelTests		WallaMarvelTests
WallaMarvelUITests		WallaMarvelUITests
fastlane		fastlane
scripts		scripts
.arkana.yml		.arkana.yml
.gitignore		.gitignore
.swiftlint.yml		.swiftlint.yml
Gemfile		Gemfile
Gemfile.lock		Gemfile.lock
Makefile		Makefile
Package.yaml		Package.yaml
README.md		README.md
SelfRunner.md		SelfRunner.md
onboarding.sh		onboarding.sh
sonar-project.properties		sonar-project.properties

knight6700/MarvelApp

Folders and files

Latest commit

History

Repository files navigation