Canvas Plus

A multi-semester initiative by iOS Club @ GT, working towards a better iOS and macOS client for students using Canvas.

Feature Database

This feature database contains a list and status of features and ideas for this project. To contribute to the list, reach out to an iOS Club exec member on our Discord server.

Resources

• Live API
• API Docs
• Understanding the Canvas API

Debugging SwiftData

• SQLite Viewer for viewing SQLite files that SwiftData writes to.
• Print the following at app launch to get the directory storing these SQLite files.

print(URL.applicationSupportDirectory.path(percentEncoded: false))

SwiftLint

This project uses SwiftLint, a Swift Package that ensures consistent code formatting across the codebase. Please resolve these before merging new code into the codebase.

SwiftLint can automatically fix most of these errors for you:

1. Install swiftlint via your Terminal: brew install swiftlint.
2. swiflint lint --fix automatically runs whenever you build or run in Xcode, which will fix most issues or throw warnings related to code formatting.

To make your life easier, you can have Xcode automatically reformat after a particular column length, and trim trailing whitespaces:

1. Open Xcode preferences (⌘ + ,)
2. Go to Text Editing > Editing
3. Turn on "Automatically reformat when completing code", "Automatically trim trailing whitespaces", and "Including whitespace-only lines"

Development Team

After cloning, run these commands to set up Git filters for development team persistence:

chmod +x .git-filters/development-team
git config filter.development-team.clean ".git-filters/development-team clean"
git config filter.development-team.smudge ".git-filters/development-team smudge"

Then, modify your Development Team under Signing & Capabilities. Add this to the Git commit. It should now not appear on the Git log but will still persist and therefore cannot be committed.