- Clone the repository
git clone git@github.com:instructure/canvas-ios.git- Install Homebrew
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"- CD to the project root folder to install project dependencies defined in the
Brewfile
make provision- CD to the project root folder to generate project files and build yarn dependencies
make syncIf you run into the error xcrun: error: SDK "iphoneos" cannot be located`.
Set Xcode Command Line Tools:
sudo xcode-select --switch /Applications/Xcode.app/Contents/DeveloperIf you have an NPM related error try installing watchman directly.
brew install watchmanand then run
sudo launchctl limit maxfiles 16384 16384 && ulimit -n 16384Any static keys, tokens, passwords, or other secrets that need to be available in the app bundle should be added as a case to Secret.swift.
The secrets necessary for a particular build are generated as data assets using a script.
yarn build-secrets "studentPSPDFKitLicense=token1" "teacherPSPDFKitLicense=token2"You will need to purchase PSPDFKitLicenses to distribute custom apps. Instructure's licenses are only used for official builds and are not included in the repository.
Writing an app is complex. Decisions made from the beginning have a big impact on the end result.
We strive to maintain a simple architecture that is easy to understand and pick up. Someone familiar with the platform should be productive within a single day.
Code should be self-documenting and easy to follow.
Ugly code is easy to recognize and its cost is easy to estimate. Neither is true for a wrong abstraction.
- Dan Abramov
Surprise! Apps have bugs. Industry average is 15-50 defects per 1000 lines of code.
We build our apps in a way that makes finding and fixing issues is as easy as possible.
Writing code in a testable way is paramount for long term success. These apps are built in a way that makes our unit testing surface as large as possible.
We make and keep strong conventions in order to reduce mental overhead.
We adhere to our Swift Style Guide.
We do things the Apple prescribed way because it offers the best long term predictability with minimal maintenance.
Models & Presenters handle as much of the business logic as possible. This allows a wide unit testing surface. Views & View Controllers should be as small as possible.
By scrutinizing each dependency we bring in, the code we write is our responsibility. Unit tests are a key portion of the code we write, so as time passes, the code that worked 2 years ago still works today.
We don't do any manual QA of our products. We write code that tests our apps for us.
😬 One day React Native, Cocoapods, and other old frameworks will be fully replaced by the swift architecture in Core. Eventually. Hopefully. 🤞
If you are connecting to a portal instance you must be connected to the VPN. This requires Full VPN tunnel and not just the typical Employee VPN connection. After you hit connect in the Cisco VPN client to connect to vpn.instructure.com there will be a drop down where you can select Full Tunnel
Generating icons from instructure.design
Most, if not all of the icons used in the Canvas apps can be found in instructure-icons, but are defined as React components, SVG, & Sketch files. Since iOS does not handle SVG files in UIImageViews natively, these are converted to PDF.
yarn build-iconsYou can generate code coverage reports with yarn coverage --scheme <SCHEME>
yarn coverage --scheme Studentyarn coverage --scheme CoreTo run tests first use yarn test
yarn test --scheme Core| Option | Description |
|---|---|
| scheme | The scheme to run against |
| os | Specify simulator os. Only available when running tests |
We have a script that should ensure the correct license header comments are in place:
yarn update-headersThis file is part of Canvas.
Copyright (C) 2019-present Instructure, Inc.
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as
published by the Free Software Foundation, either version 3 of the
License, or (at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
MDM Profile settings are saved in UserDefaults.standard and keyed by
com.apple.configuration.managed.
These logins are added to the list of previous logins on the start screen.
Use our MDMManager to observe changes such as managed logins.
You can test this locally with command line arguments.
Scheme > Edit Scheme > Run > Arguments > Arguments Passed on Launch
-com.apple.configuration.managed '<dict><key>enableLogin</key><true/><key>users</key><array><dict><key>host</key><string>canvas.instructure.com</string><key>username</key><string>student</string><key>password</key><string>Canvas2019</string></dict></array></dict>'
Change the username, password, and host to your test credentials. You can also add host and authenticationProvider strings to the top level dict to skip the "Find my school" screen during login.
Xcode templates can be found under the ./.github/templates directory. Copy the contents of that directory to ~/Library/Developer/Xcode/Templates/. Run make sync to update your project after you have created your files from these templates.