@@ -6,31 +6,22 @@ The open source code provided by the Android Team at Instructure.
66
77## Building
88
9- First, install the Flutter SDK using the instructions found [ here] ( https://flutter.dev/docs/get-started/install ) .
10-
11- Next, run ` ./open_source.sh ` once. You may now use Gradle to build the apps.
9+ Run ` ./open_source.sh ` once. You may now use Gradle to build the apps.
1210
1311### Student, Teacher and native Parent
1412
15131 . Open ` apps/build.gradle ` in Android Studio
16- ```
17- Android Studio > Import Project > canvas-android/apps/build.gradle
18- ```
19-
20- 2 . Select the app from the list of configurations (` student ` or ` teacher ` )
21- 3 . Tap 'Run' (` ^R ` ) to run the app
22-
23- ### Flutter Parent
24-
25- 1 . Open ` canvas-android/apps/flutter_parent ` in Android Studio.
26- 2 . Make sure the ` main.dart ` configuration is selected
14+ ```
15+ Android Studio > Import Project > canvas-android/apps/build.gradle
16+ ```
17+ 2. Select the app from the list of configurations
27183. Tap 'Run' (`^R`) to run the app
2819
29- App | Command | Build Status
30- --- | --- | ---
31- Student | ` ./gradle/gradlew -p apps :student:assembleDevDebug ` | [ ![ Student build Status ] ( https://app.bitrise.io/app/9417c28328c02b7c/status. svg?token=D7fHdeUlz19PurcEPIQNzw&branch=master )] ( https://app.bitrise.io/app/9417c28328c02b7c )
32- Teacher | ` ./gradle/gradlew -p apps :teacher:assembleDevDebug ` | [ ![ Teacher build Status ] ( https://app.bitrise.io/app/4f5339d0ec3436ca/status. svg?token=ATqaYNnYyS4eDUxc0d9EZQ&branch=master )] ( https://app.bitrise.io/app/4f5339d0ec3436ca )
33- Parent | (in apps/flutter_parent) ` flutter pub get; flutter build apk ` | [ ![ Parent build Status ] ( https://app.bitrise.io/app/39fd3312f33be200/status. svg?token=jiiPeSZlSxrx5lkqccLN1Q&branch=master )] ( https://app.bitrise.io/app/39fd3312f33be200 )
20+ | App | Command | Build Status |
21+ | ---------| ------------------------------------------------------| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
22+ | Student | `./gradle/gradlew -p apps :student:assembleDevDebug` | [](https://github.com/instructure/canvas-android/actions/workflows/open-source-build-student.yml) |
23+ | Teacher | `./gradle/gradlew -p apps :teacher:assembleDevDebug` | [](https://github.com/instructure/canvas-android/actions/workflows/open-source-build-teacher.yml) |
24+ | Parent | `./gradle/gradlew -p apps :parent:assembleDevDebug` | [](https://github.com/instructure/canvas-android/actions/workflows/open-source-build-parent.yml) |
3425
3526## Running tests
3627
@@ -42,11 +33,11 @@ To run unit tests for Student, Teacher and native Parent
4233
4334#### The Applications we have published on Google Play.
4435
45- App | Description
46- --- | ---
47- [ Canvas Student] [ canvas ] | Used by Students all over the world to be smarter, go faster, and do more.
48- [ Canvas Teacher] [ teacher ] | User by Teachers all over the world to update course content or grade on the go.
49- [ Canvas Parent] [ parent ] | Used by Parents all over the world to be parents.
36+ | App | Description |
37+ | ---------------------------| ----------------------------------------------------------------------------------|
38+ | [Canvas Student][canvas] | Used by Students all over the world to be smarter, go faster, and do more. |
39+ | [Canvas Teacher][teacher] | User by Teachers all over the world to update course content or grade on the go. |
40+ | [Canvas Parent][parent] | Used by Parents all over the world to be parents. |
5041
5142[canvas]: https://play.google.com/store/apps/details?id=com.instructure.candroid
5243[teacher]: https://play.google.com/store/apps/details?id=com.instructure.teacher
@@ -56,20 +47,20 @@ App | Description
5647
5748#### These are things that we use internally to create our applications.
5849
59- Module | Description
60- --- | ---
61- annotations | A wrapper for the PSPDFKit library and logic for annotation handling and converting in PDF documents.
62- buildSrc | Library for common gradle dependencies and gradle transformers that are used by the project.
63- canvas-api-2 | Canvas for Android Api used to talk to the Canvas LMS and is testable.
64- dataseedingapi | gRPC wrapper for Canvas that enables creating data to test the apps.
65- DocumentScanner | A wrapper for document scanning features.
66- espresso | The UI testing library built on Espresso.
67- interactions | Interactions for navigation used in the apps.
68- login-api-2 | The libarary used to make logging in and getting a token relative easy and is testable.
69- pandares | Collection of resources used in our apps.
70- pandautils | The core library for the apps. All the common code is implemented here that is reused by the 3 apps.
71- rceditor | A wrapper for rich content editing used in our apps.
72- recyclerview | A fancy RecyclerView library that supports expanding and collapsing, pagination, and stuff like that. (deprecated)
50+ | Module | Description |
51+ | ----------------| --------------------------------------------------------------------------------------------------------------------|
52+ | annotations | A wrapper for the PSPDFKit library and logic for annotation handling and converting in PDF documents. |
53+ | buildSrc | Library for common gradle dependencies and gradle transformers that are used by the project. |
54+ | canvas-api-2 | Canvas for Android Api used to talk to the Canvas LMS and is testable. |
55+ | dataseedingapi | gRPC wrapper for Canvas that enables creating data to test the apps. |
56+ | espresso | The UI testing library built on Espresso. |
57+ | horizon | Canvas Career experience for the Student app. |
58+ | interactions | Interactions for navigation used in the apps. |
59+ | login-api-2 | The libarary used to make logging in and getting a token relative easy and is testable. |
60+ | pandares | Collection of resources used in our apps. |
61+ | pandautils | The core library for the apps. All the common code is implemented here that is reused by the 3 apps. |
62+ | rceditor | A wrapper for rich content editing used in our apps. |
63+ | recyclerview | A fancy RecyclerView library that supports expanding and collapsing, pagination, and stuff like that. (deprecated) |
7364
7465#### Our applications are licensed under the GPLv3 License.
7566
0 commit comments