Kukariri 🧠

Android application which handles the Spaced Repetition System (SRS)

Functionality

To test the functionality of this app, first go to one of the other apps/games where the student is learning new words (e.g. the Vitabu app), and press a word. Then, 4 minutes after that initial LearningEvent, the word will appear here in the Kukariri app for review.

Installation

Important

Note: This app depends on the elimu.ai Content Provider to be installed.

Development 👩🏽‍💻

Compile APK:

./gradlew clean build

Install APK:

adb install app/build/outputs/apk/debug/app-debug.apk

Code Coverage

./gradlew jacocoTestReport
open app/build/jacoco/jacocoHtml/index.html

Content Provider Utils 📦

If you want to make changes to the elimu.ai Content Provider's utility library, see testing instructions at https://github.com/elimu-ai/content-provider/blob/main/README.md#utils-snapshot

Gradle Upgrade

./gradlew wrapper --gradle-version x.x.x

Release 📦

To perform a release, follow these steps:

1. Merge your PR into the main branch
2. Wait for the "Gradle Release" workflow to complete
3. Ensure that the new release version appears at https://github.com/elimu-ai/kukariri/releases

---

elimu.ai - Free open-source learning software for out-of-school children 🚀✨

Website 🌐  •  Wiki 📃  •  Projects 👩🏽‍💻  •  Milestones 🎯  •  Community 👋🏽  •  Support 💜