开源软件名称：

开源软件地址：

开源编程语言：

开源软件介绍：

Canvas iOS Apps

• Student
• Teacher
• Parent

Getting Started on Development

You will need the following tools installed beforehand:

• Cocoapods
• SwiftLint
• node
• yarn
• react-native-cli

brew install swiftlint yarn
gem install cocoapods
yarn global add react-native-cli --prefix /usr/local

Then you can setup the repo:

git clone [email protected]:instructure/canvas-ios.git
cd canvas-ios
./setup.sh

The setup.sh script should take care of installing additional dependencies from Cocoapods and yarn.

Secrets

Any 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.

Firebase Analytics

If you wish to use Firebase Analytics in custom apps, you will need to populate the GoogleService-Info.plist for each app.

Debugging Redux

To get redux logs you can add redux-logger as a middleware to the redux store.

We don't want to keep the logger in because it slows down the runtime quite a lot.

In src/redux/store.js

import logger from 'redux-logger'

let middleware = [promiseMiddleware, errorHandler, createPersisteMiddleware(500), logger]

The redux logs will now show up in the React Native Debugger.

Contributing Guiding Principles

Simple

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

Easy to Debug

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.

Testable

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.

Conventions

We make and keep strong conventions in order to reduce mental overhead.

No Tricky Stuff

We do things the Apple prescribed way because it offers the best long term predictability with minimal maintenance.

Fat Model, Thin Controller

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.

Predictable

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.

Automation

We don't do any manual QA of our products. We write code that tests our apps for us.

Prune Legacy Code