You'll need a few things before we get started. Make sure you have Xcode installed from the App Store. Then run the following command to install Xcode's command line tools, if you don't have that yet
xcode-select --install
Install Bundler
for managing Ruby gem dependencies
[sudo] gem install bundler
Install Brew package manager for macOS:
For MacOS Catalina, macOS Mojave, and MacOS Big Sur:
/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
For macOS High Sierra, Sierra, El Capitan, and earlier:
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)"
Install Node
(required to install Apollo)
brew install node
The following commands will set up SwiftHub
cd AnimalHelper
bundle install
bundle exec fastlane setup
To update all tools and pods
bundle exec fastlane update
Alrighty! We're ready to go!
You can generate the API docs locally. Run jazzy
from the root of this repository. This requires installation of jazzy. You will find the output in docs/
. You can set options for your projectโs documentation in a configuration file, .jazzy.yaml by default.
Flex debugging tool has been integrated in this application. To enable it, just swipe right anywhere in the application. There are also included debugging Hero animations. To use it, swipe right with two fingers. Repeat this to disable.
Fastlane automates common development tasks - for example bumping version numbers, running tests on multiple configurations, or submitting to the App Store. You can list the available lanes (our project-specific scripts) using bundle exec fastlane lanes
. You can list available actions (all actions available to be scripted via lanes) using bundle exec fastlane actions
. The fastlane configuration and scripts are in the fastlane
folder.
MIT License. See LICENSE.