Skip to content

Latest commit

 

History

History
109 lines (79 loc) · 4.96 KB

README.md

File metadata and controls

109 lines (79 loc) · 4.96 KB
Raw

Instructure Android

Instructure's Open Source Android Code

The open source code provided by the Android Team at Instructure.

Building

First, install the Flutter SDK using the instructions found here.

Next, run ./open_source.sh once. You may now use Gradle to build the apps.

Student, Teacher and native Parent

  1. Open apps/build.gradle in Android Studio
Android Studio > Import Project > canvas-android/apps/build.gradle
  1. Select the app from the list of configurations (student or teacher)
  2. Tap 'Run' (^R) to run the app

Flutter Parent

  1. Open canvas-android/apps/flutter_parent in Android Studio.
  2. Make sure the main.dart configuration is selected
  3. Tap 'Run' (^R) to run the app
App Command Build Status
Student ./gradle/gradlew -p apps :student:assembleDevDebug Student build Status
Teacher ./gradle/gradlew -p apps :teacher:assembleDevDebug Teacher build Status
Parent (in apps/flutter_parent) flutter pub get; flutter build apk Parent build Status

Running tests

To run unit tests for Student, Teacher and native Parent

  1. Open the Build Variants window and set the variant to qaDebug for the app that you wish to test.
  2. You can run the tests by tapping on the play button next to the test case or the test class.

Applications:

The Applications we have published on Google Play.

App Description
Canvas Student Used by Students all over the world to be smarter, go faster, and do more.
Canvas Teacher User by Teachers all over the world to update course content or grade on the go.
Canvas Parent Used by Parents all over the world to be parents.

Modules:

These are things that we use internally to create our applications.

Module Description
annotations A wrapper for the PSPDFKit library and logic for annotation handling and converting in PDF documents.
blueprint An MVP Architecture that depends on PandaRecyclerView. (deprecated)
buildSrc Library for common gradle dependencies and gradle transformers that are used by the project.
canvas-api-2 Canvas for Android Api used to talk to the Canvas LMS and is testable.
dataseedingapi gRPC wrapper for Canvas that enables creating data to test the apps.
DocumentScanner A wrapper for document scanning features.
espresso The UI testing library built on Espresso.
interactions Interactions for navigation used in the apps.
login-api-2 The libarary used to make logging in and getting a token relative easy and is testable.
pandares Collection of resources used in our apps.
pandautils The core library for the apps. All the common code is implemented here that is reused by the 3 apps.
rceditor A wrapper for rich content editing used in our apps.
recyclerview A fancy RecyclerView library that supports expanding and collapsing, pagination, and stuff like that. (deprecated)

Our applications are licensed under the GPLv3 License.

Copyright (C) 2016 - present  Instructure, Inc.

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, version 3 of the License.

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 General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.

Our Modules are licensed under the Apache v2 License.

Copyright (C) 2016 - present Instructure, Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.