alexbarbosabr / MarvelCharacters

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Marvel Characters

This project was developed in Swift with UIKit and aims to present the Marvel characters in an iOS app.

Light e Dark Mode

The app is adaptable to the theme of the operating system.

Features

  • Character list
  • Character details
  • Character search
  • Favorite list

Menu

Starting

The following instructions will provide you with a copy of the project and allow you to run it on your computer.

Prerequisites

  • Computer with macOS Ventura 13 or higher

Installation guide

Install the tools below to be able to run the app in Xcode.

Xcode

Download Xcode from App Store.

Homebrew

Follow the installation instructions on the website brew or run the command below in the terminal:

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)"

Note: For Mac with Apple Silicon processor, you will need to run the command below in the terminal.

  1. echo 'eval "$(/opt/homebrew/bin/brew shellenv)"' >> /Users/YOUR USER/.zprofile

SwiftGen

In terminal run:

brew install swiftgen

SwiftLint

In terminal run:

brew install swiftlint

CocoaPods

In terminal run:

sudo gem install cocoapods

Note: For Mac with Apple Silicon processor, you will need to run the commands below.

  1. sudo arch -x86_64 gem install ffi
  2. arch -x86_64 pod install

Cloning the repository

In terminal, open the directory of your choice and run the command line below to clone the repository.

git clone https://github.com/alexbarbosabr/MarvelCharacters.git

At the end of the clone, open the root folder of the project in the terminal and execute the command:

pod install

After installing the Pods, open the .xcworkspace file located in the root folder of the project.

Additional information

Tests

The project has automated tests on MarvelCharactersTests and MarvelCharactersUITests targets. For the MarvelCharactersTests snapshot tests, the iPhone SE (3nd generation) simulator with iOS 16.4 was used. Other simulators with the same aspect ratio may work.

Libraries used

Installation via CocoaPods:

  • Nimble-Snapshots (UI Tests)
  • KIF (Instrumented and Functional tests)
  • KIF/IdentifierTests (Instrumented and functional tests)

Installation via Swift Package Manager:

  • Kingfisher (Download images)

About


Languages

Language:Swift 99.4%Language:Ruby 0.4%Language:Objective-C 0.3%