Skip to content
This repository has been archived by the owner on Nov 17, 2023. It is now read-only.

Latest commit

 

History

History
60 lines (36 loc) · 1.72 KB

INSTALL.md

File metadata and controls

60 lines (36 loc) · 1.72 KB

Installation

Preliminaries

Xcode 11.1 or above is required to run the app.

First Step

  1. Run git submodule update --init --recursive to download git submodules.
  2. Run carthage bootstrap --platform iOS to download the required frameworks.

Helpful Tools and Next Steps

The following tools are used to simplify working on the app:

Bundler

Bundler provides a consistent environment for Ruby projects by tracking and installing the exact gems and versions that are needed. In Zap iOS it is used to pin cocoapod and fastlane versions.

Install the dependencies located in the Gemfile by running:

bundle install

If you would like to learn more take a look at https://www.mokacoding.com/blog/ruby-for-ios-developers-bundler/

SwiftLint

Enforce Swift style and conventions (https://github.com/realm/SwiftLint)

SwiftGen

Code generator for your assets, storyboards, Localizable.strings (https://github.com/SwiftGen/SwiftGen) Generates three files in the Library framework:

  • Assets.swift
  • StoryboardScenes.swift
  • Strings.swift
CocoaPods

For managing dependencies (https://cocoapods.org)

Zap iOS uses CocoaPods in order to install and managed the swift/Objective-C dependencies. To install the CocoaPods managed dependencies, run the following command:

bundle exec pod install

This command guarantees that the version of CocoaPods specified in the Gemfile.lock is used to pod install the dependencies listed in the Podfile.lock.

If you would to update a pod to a newer version, make the appropriate changes in the Podfile and then run the following command:

pod update [PODNAME]
Fastlane

For automating the development and release process (https://fastlane.tools)