- Clone the repo don't forget to fetch srReview and peerReview branches
- This project uses homeBrew if you do already have homeBrew installed run brew update otherwise install homebrew using the following command /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)" Homebrew is a command-line tool that is used to install other development tools. For more details about homebrew view there site
- This project also uses XcodeGen to avoid merge conflicts in the project file. XcodeGen is a command-line tool that creates/recreates a project file from a YAML specification contained in the project.yml file. Details about how to write this YAML specification can be found here. The initial project.yml file is configured such that any files added to the source directory will be included in the xkcd target. The xkcd.project file has been added to the .gitignore file for this repo. Instead of sharing this file which can lead to merge conflicts each developer will generate there own copy of the xkcd.project file using XcodeGen when the project is changed. For more details about XcodeGen view their GitHub repo To install XcodeGen run brew install xcodeGen
- This project also uses swiftLint. SwiftLint is a linting tool, that enforces some swift style and syntax conventions. For more information about swift lint see there repo To install swiftLint run 'brew install swiftLint'
- In terminal cd into the project's root directory
- Run make to build the project file. Make is a UNIX command-line tool that runs the commands contained in the makefile. The initial commands in this file delete the xkcd.project file if it is present, and regenerates the xkcd.project file using XcodeGen. More details about make can be found here and here
- Open xkcd.xcodeproj with Xcode
- You should now be able to build and run the project
- We will be using the AirBnB Style guide
- Out slack workspace is CodeCritique.slack.com
- xkcd api docs
- Wireframes are available here
- slack invite