model (library) 📦

Code library shared amongst the Webapp and Android applications.

Software Architecture 📐

Development 👩🏽‍💻

mvn clean
mvn compile

Release 📦

To perform a release, follow these steps:

1. Merge your PR into the main branch
2. Wait for the "Maven Release" workflow to complete
3. Ensure that the new release version appears at https://jitpack.io/#ai.elimu/model with "Status: ok"

Important

After you publish a new release, remember to also bump the version in the Webapp repo and all Android app repos that depend on the utils library:

• https://github.com/elimu-ai/webapp/blob/main/pom.xml
• https://github.com/elimu-ai/analytics/blob/main/gradle/libs.versions.toml

Write release notes 🗒️

If the PR that you merged contains breaking changes, go to https://github.com/elimu-ai/model/tags and press "Create release." Then write instructions on how to handle the breaking changes.

Usage

After each release, the resulting .jar file gets uploaded to https://jitpack.io/#ai.elimu/model

Gradle

./build.gradle:

repositories {
    mavenCentral()
+    maven { url "https://jitpack.io" }
}

./app/build.gradle:

dependencies {
    implementation 'ai.elimu:model:<version>'
}

Maven

./pom.xml:

<repository>
    <id>jitpack.io</id>
    <url>https://jitpack.io</url>
</repository>

<dependency>
    <groupId>ai.elimu</groupId>
    <artifactId>model</artifactId>
    <version>Tag</version>
</dependency>

---

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

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