OpenOtago - COSC345 Project

---

OpenOtago is an android replacement to Univeristy of Otago's online resources

Created by

• Damian Soo (6551336)
• Garth Wales (4861462)
• Louis Whitburn (2548261)

---

User documentation

Latest version: v1.0

App store: F-Droid

See full description

See screenshots

If you wish to submit a bug or have an issue please drop a message here

---

App stores pull description, images and changelogs from directory fastlane/metadata/android/en-US

If commiting changes to user documentation see explanation

---

Commiting Code

Each commit runs the pipelines found in .github/workflows/

test.yml

• Runs unit tests
• Runs instrumentation tests
• Generates code coverage

build.yml

• Tests build success

publishDocs.yml

• Deploys documentation

Codacy completes static analysis on each commit to recognise potential code pitfalls.

All known issues are tracked with github issues

---

Requirements to build

• Java Environment
• Android SDK version 29

---

To build application

• Clone the repository

• Option 1 - Android Studio:

  • Open with Android Studio, wait for initial gradle setup
  • Build (Ctrl+F9) / Emulate (Shift+F10)

• Option 2 - *NIX:

  • ./gradlew assembleDebug
  • install /app/build/outputs/apk/debug/app-debug.apk onto device

To run instrumentation tests (on your machine)

• ./gradlew connectedCheck (Run instrumentation tests)

This will need a suitable device to run on (e.g. an emulator). This is easiest via Android Studio.

For other tests (on your machine)

• ./gradlew testDebug (Run unit tests)
• ./gradlew lintDebug (Basic static analysis)

---

For more

See initial proposal

See latest documentation

See github issues

See unit test code & instrumented test code