openHPI/xikolo-ios

Name: xikolo-ios

Owner: HPI Knowledge Tech Group

Description: iOS App for openHPI, openSAP, mooc.house and OpenWHO

Created: 2015-06-25 07:45:02.0

Updated: 2018-01-26 17:56:11.0

Pushed: 2018-02-19 15:08:36.0

Homepage: https://itunes.apple.com/us/developer/hasso-plattner-institut/id440210904

Size: 38573

Language: Swift

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

xikolo-ios

iOS application for openHPI, openSAP, mooc.house and OpenWHO

Development toolchain

• Xcode 9.2
• bundler: gem install bundler

The following tools will be installed via bundler:

• CocoaPods
• fastlane

The following tools will be installed via CocoaPods:

• SwiftLint
• BartyCrouch

How to get started

• clone this repository
• run bundle install
• run bundle exec pod repo update and bundle exec pod install
• open xikolo-ios.xcworkspace in Xcode
• start one of the defined targets

Setup fastlane

• make your own Appfile via cp fastlane/Appfile.dummy fastlane/Appfile
• set the following values
• apple_id
• itunes_connect_id (if required)
• for all available fastlane commands have a look at the fastlane Readme
• some commands require setting the app environment via --env {openhpi|opensap|moochouse|openwho}

Setup testing

• copy the credentials plist dummy file cp UI\ Tests/Credentials.plist.dummy UI\ Tests/Credentials.plist
• enter your login credentials for testing

Contributing

If you would like to contribute by adding a feature or fixing a bug, feel free to do so. You can have a look at the open issues to get some inspiration and create a pull request as soon as you are ready to go.

Code formatting

In order to have a consistent code formatting, we would like you to set some settings:

• for less unneccessary whitespace changes please set both checkboxes in Xcode->Preferences->Text Editing regarding whitespaces
• use Unix-style line endings (LF)

Localization

We use BartyCrouch to ensure a complete localization of the applications. Simple run bundle exec fastlane localize to add entries for missing localizations in storyboard files and NSLocalizedString usages. Here are some tips to promote a consistent usage:

Exlusion of storyboard elements

Add #bc-ignore! to 'Comment For Localizer' box in the utilities pane instead of adding #bc-ignore! to the elements value.

Use name-spaced keys for NSLocalizedString

To add more context to single localized strings, we use name-spaced keys instead of the english text. The english text is stored in Localizable.strings (Base). In this way we also avoid unneccesary long localization keys. So, we write:

calizedString("course.section-title.my courses", comment: ...)

instead of

calizedString("My Courses", comment: ...)

Support of stringsdict files

Add #bc-ignore! to the user comment of NSLocalizedString

format = NSLocalizedString("%d hours", comment: "<number> of hours #bc-ignore!")

How to release to apps

• Install git-crypt via brew install git-crypt
• Retrieve the xikolo-ios.key from the openHPI team and run git-crypt unlock /path/to/xikolo-ios.key
• Use the standard Xcode workflow to upload the app to iTunesConnect (You have to possess the iOS Distribution Certificate)