/ao-swift

swift training

Primary LanguageShell

%project-name iOS

%project-ci-badge %project-codestats-badge

%project-description

Project info & resources

  • Project Manager: %pm-full-name - %pm-email-address

  • Technical Leader: %tl-full-name - %tl-email-address

Setup

Create a GitHub access token

You will also need to create a GitHub access token for the bootstrap script. Check this tutorial on how to do that. The boostrap script requires GitHub credentials to be able to download private dependencies.

Configure CarthageCache

This project uses CarthageCache to cache Carthage's build folder and speed up total build time. The boostrap script will try to generate the .carthage-cache.yml file. It will prompt you for the AWS credentials and region. Ask the project's manager to generate a set of crendetials before bootstrapping the project. If you don't configure CarthageCache the boostrap script will tell Carthage to download and build all dependencies.

Bootstrap project

After setting up the required accounts from all third party service, run the following commands:

git clone %project-git-ssh-url
cd %project-root-directory-name
script/bootstrap
open %project-xcodeproj-file

If any of the previous commands fail please submit an issue specifying the command output, OS X version and XCode version.

Scripts

Inside the script folder there are several scripts to facilitate the development process. For up to date documentation of this scripts check this repository. The most relevant scripts are:

  • script/bootstrap: Bootstraps the project for the first time.
  • script/test: Runs the project's tests
  • script/update: Updates the project's dependencies.

Guidelines

Please before adding any code read the pull request template on how to submit a pull request with the proper format to be able to be merged upstream and also the coding guidelines that must be followed.