O-Week v3.2

Contents

• About
• Getting Started
• Dependencies & Libraries
• Screenshots
• Contributors

About

An iOS app for incoming freshmen to use during their first week as a Cornell student. Available on the App Store here. The Android branch can be found here.

Getting Started

You will need Xcode 9.4.1 to run the latest version of this app, which uses Swift 4 compiled for iOS 11.4. Xcode can be downloaded from the Mac App Store. Make sure you are not running a beta version of macOS, as Apple will prevent you from publishing to the App Store if you do.

Design Choices

• Document every function and at the start of every class/enum/protocol. Here are the guidelines for documentation.
• Syntax:
  • Indent with tabs.
  • Put curly braces on a new line, like so:

  if (blah)
  {
     doSomething()
     doSomethingElse()
  }

  • If a statement fits in a single line, curly braces don't have to go on a new line, like so:

  if (blah) {
     doSomething();
  }

  This is especially true for get and guard statements, where the curly braces aren't allowed to be on a new line.
  • ClassesShouldBeNamedLikeThis, as should enums and protocols. (upper camel case)
  • functionsShouldBeNamedLikeThis, as should non-static variables or let constants. (lower camel case)
  • STATIC_VARS_SHOULD_BE_NAMED_LIKE_THIS, as should any let constants (or variables whose values shouldn't be changed).

Dependencies & Libraries

Unlike Android, which manages its dependencies through Gradle, iOS requires CocoaPods and the editing of the Podfile in the main project directory. If you don't have CocoaPods installed on your computer, follow the instructions here under the tabs Install and Get Started.

• PureLayout is a set of extensions added unto UIView to make setting programmatic constraints easy and readable.
• PKHUD is an implementation of Heads Up Displays in iOS, used like Toasts in Android to provide feedback for user actions.

Screenshots

Screenshots showing major parts of app

Contributors

2018

• David Chu - Developer Lead

2017

• David Chu - Product Manager

2016

• David Chu - Front-End Developer
• Vicente Caycedo - Front-End Developer

We are a team within Cornell Design & Tech Initiative. For more information, see its website here.