https://github.com/elimu-ai/model
📦 Code library shared amongst the Webapp and Android applications
https://github.com/elimu-ai/model
jar java library
Last synced: 11 months ago
JSON representation
📦 Code library shared amongst the Webapp and Android applications
- Host: GitHub
- URL: https://github.com/elimu-ai/model
- Owner: elimu-ai
- License: mit
- Created: 2016-01-02T13:59:31.000Z (over 10 years ago)
- Default Branch: main
- Last Pushed: 2025-07-26T04:22:43.000Z (11 months ago)
- Last Synced: 2025-07-26T10:49:19.279Z (11 months ago)
- Topics: jar, java, library
- Language: Java
- Homepage: https://jitpack.io/#ai.elimu/model
- Size: 678 KB
- Stars: 4
- Watchers: 12
- Forks: 8
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
[](https://jitpack.io/#ai.elimu/model)
# model (library) 📦
Code library shared amongst the [Webapp](https://github.com/elimu-ai/webapp) and Android applications.
## Software Architecture 📐
[
](https://github.com/elimu-ai/wiki/blob/main/SOFTWARE_ARCHITECTURE.md)
## Development 👩🏽💻
```
mvn clean
mvn compile
```
## Release 📦
To perform a release, follow these steps:
1. Merge your PR into the `main` branch
1. Wait for the ["Maven Release"](https://github.com/elimu-ai/model/actions/workflows/maven-release.yml) workflow to complete
1. 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`:
```diff
repositories {
mavenCentral()
+ maven { url "https://jitpack.io" }
}
```
`./app/build.gradle`:
```gradle
dependencies {
implementation 'ai.elimu:model:'
}
```
### Maven
`./pom.xml`:
```xml
jitpack.io
https://jitpack.io
```
```xml
ai.elimu
model
Tag
```
---
elimu.ai - Free open-source learning software for out-of-school children 🚀✨
Website 🌐
•
Wiki 📃
•
Projects 👩🏽💻
•
Milestones 🎯
•
Community 👋🏽
•
Support 💜