iOS base is a boilerplate project created by Rootstrap for new projects using Swift 5. The main objective is helping any new projects jump start into feature development by providing a handful of functionalities.
This template comes with:
- Complete API service class to easily communicate with REST services.
- Examples for account creation and Facebook integration.
- Useful classes to manage User and Session data.
- Secure way to store keys of your third party integrations.
- Generic implementation of navigation between view controllers.
- Handy helpers and extensions to make your coding experience faster and easier.
This App Template also contains other branches with specific features that may be of use to you:
- feature/mvvm+rxswift in case you want to work with RxSwift and MVVM.
- feature/jenkins to integrate build and release with Jenkins.
- feature/moya_integration manage routes and HTTP resources with Moya and Alamofire.
To use them simply download the branch and locally rebase against master/develop from your initial iOS base clone. Important: See steps below on how to install this features.
- Clone repo.
- Install desired extensions from their branches.
- Run
./init
from the recently created folder. - Initialize a new git repo and add your remote url.
- Done!
To manage user and session persistence after the original sign in/up we store that information in the native UserDefaults. The parameters that we save are due to the usage of Devise Token Auth for authentication on the server side. Suffice to say that this can be modified to be on par with the server authentication of your choice.
- Alamofire for easy and elegant connection with an API.
- IQKeyboardManagerSwift for auto-scrolling to current input in long views. Note: this pod is not fully working on iOS 11. Here is the issue we encountered and the meantime solution.
- R.swift for strongly typed and autocompleted assets, segues and more.
We have developed other libraries that can be helpful and you could integrate with the dependency manager of your choice.
- PagedLists: Custom
UITableView
andUICollectionView
classes to easily handle pagination. - RSFontSizes: allows you to manage different font sizes for every device screen size in a flexible manner.
- RSFormView: a A library that helps you to build fully customizable forms for data entry in a few minutes.
- SwiftGradients: Useful extensions for
UIViews
andCALayer
classes to add beautiful color gradients.
- KIF for UI testing.
- KIF/IdentifierTests to have access to accesibility identifiers.
- FBSDKCoreKit facebook pods dependency.
- FBSDKLoginKit for facebook login.
- In
info.plist
on the URL types array, findfbXXXXXXXXXXX
and replace it for the string "fb" + the ID of your app. i.e:fb435272928934
. - Change the
FacebookAppID
value for the same AppID that you replace above. - Change the
FacebookDisplayName
value for the name of the app on Facebook. - Done :)
In order to meet the required code quality standards, this project runs SwiftLint during the build phase and reports warnings/errors directly through XCode. The current SwiftLint rule configuration is based on Rootstrap's Swift style guides and is synced with the CodeCliemate's configuration file.
NOTE: Make sure you have SwiftLint version 0.35.0 or greater installed to avoid known false-positives with some of the rules.
We strongly recommend that all private keys be added to a .plist
file that will remain locally and not be committed to your project repo. An example file is already provided, these are the final steps to set it up:
- Rename the
ThirdPartyKeys.example.plist
file on your project so that it is calledThirdPartyKeys.plist
. To add a set of keys simply add a dictionary with the name you want the key to have and add the corresponding Debug, Staging and Release keys as items. - Remove the reference of
ThirdPartyKeys.plist
from XCode but do not delete the file. This way, you will keep the file locally(it is already in the .gitignore list) in the project directory. Note: Do NOT move the file from the current location, the script uses the $(PROJECT_DIR) directory. - Go to Product -> Scheme -> Edit scheme. Then select Pre-actions for the Build stage and make sure that the
Provided build setting
is set to your current target. Repeat this step for the Post-actions script. - Done :)
We use Fastlane to automate code signing, building and deployment.
Several steps need to be executed before building a project for the first time.
- Install latest Xcode command line tools
xcode-select --install
- Install latest Fastlane
# Using RubyGems
sudo gem install fastlane -NV
# Alternatively using Homebrew
brew install fastlane
- Create required App Ids in the Apple Developer Portal and App Store Connect This can be done on the Portal itself or using fastlane produce
fastlane produce -u {apple_id} --app-name {app_name} --team-id {team_id} --app-identifier {app_id}
-
Create private empty repository to store signing certificates, eg.
[email protected]:rootstrap/{app_name}-certificates.git
-
Generate Matchfile with fastlane match
fastlane match init
select git
as storage mode and specify the URL of the certificates git repo
- optional If the Developer account has old/invalid certificates which are not shared, it is recommended to use the
nuke
action to clear the existing certificates (use with caution):
fastlane match nuke development
fastlane match nuke distribution
- optional If wanting to reuse existing distribution certificates, these can be imported into the certificates repository using match with the
import
action:
fastlane match import \
--username {{username}} \
--git_url {{certificates_git_url}} \
--team_id {{team_id}} \
--type appstore \
--app_identifier com.{{company}}.{{app_name}} \
* Fastlane will prompt for location of the `.cer` and `.p12` files
* Fastlane will require setting a passphrase for encrypting the files in git
- Generate app bundle identifiers
fastlane match appstore -u {{username}} --team-id {{team_id}} -a com.{{company}}.{{app_name}}
- Check the
fastlane/Appfile
andfastlane/Fastfile
; set and/or validate the following values before use: -app_name
# this will match with application name in App Store and target schemes in the project -username
# The apple id used to manage the certificates -certificates_git_url
# The repo to store and sync certs and provisioning profiles -team_id
# The organization's team id -itc_team_id
# App Store Connect team id -devices
# List of devices to launch simulators for running tests on
fastlane ios {{lane}}
Lanes for each deployment target are provided with some basic behavior, which can be modified as needed:
-
Each target has two options:
build_x
andrelease_x
.- The
build
lane will build the application signed with an Ad Hoc certificate and keep the.ipa
in the local folder for upload. - The
release
lane will:- Check the repo status (it has to be clean, with no pending changes)
- Increment the build number.
- Tag the new release and push it to the set branch (dev and staging push to develop and production to master by default, but it's configurable).
- Build the app signed with an App Store certificate
- Generate a changelog from the commit diff between this new version and the previous.
- Upload to testflight and wait until it's processed.
- The
-
Additionally, lane
test_develop
can be used by the CI job to only run the unit test against simulators (specified bydevices
variable in Fastfile)
iOS-Base is available under the MIT license. See the LICENSE file for more info.
NOTE: Remove the free LICENSE file for private projects or replace it with the corresponding license.
iOS Base is maintained by Rootstrap with the help of our contributors.