https://github.com/elimu-ai/content-provider
🗂 Android application which downloads educational content to the device and provides it to other apps
https://github.com/elimu-ai/content-provider
infrastructural
Last synced: 3 months ago
JSON representation
🗂 Android application which downloads educational content to the device and provides it to other apps
- Host: GitHub
- URL: https://github.com/elimu-ai/content-provider
- Owner: elimu-ai
- License: mit
- Created: 2019-01-01T21:56:52.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2025-02-24T15:54:45.000Z (4 months ago)
- Last Synced: 2025-02-24T16:42:45.894Z (4 months ago)
- Topics: infrastructural
- Language: Java
- Homepage: https://jitpack.io/#elimu-ai/content-provider
- Size: 1.09 MB
- Stars: 1
- Watchers: 9
- Forks: 0
- Open Issues: 24
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# elimu.ai Content Provider
Android application which downloads educational content (e.g. letters, words, audios, storybooks, videos, etc) to the
device and provides it to other elimu.ai apps.
See software architecture diagram at https://github.com/elimu-ai/model/blob/main/README.md
## Software Architecture
[
](https://github.com/elimu-ai/wiki/blob/main/SOFTWARE_ARCHITECTURE.md)
## Utils Library 📦
The Content Provider comes with a [`utils`](utils) library (`.aar`) which makes it easier for other Android apps to fetch content from the Content Provider.
> [!NOTE]
> Here is how to use the `utils` library in another Android app:
1. Add repository:
```
allprojects {
repositories {
...
maven { url 'https://jitpack.io' }
}
}
```
2. Add dependency:
```
dependencies {
implementation 'com.github.elimu-ai:content-provider:@aar'
}
```
See https://jitpack.io/#elimu-ai/content-provider/ for the latest version available.
> [!TIP]
> To find all Android app repos that depend on this library, go to https://github.com/search?q=org%3Aelimu-ai+com.github.elimu-ai%3Acontent-provider%3A&type=code
### Usage Example
For an example of another Android app using the `utils` library, see the Vitabu app's Gradle configuration:
1. https://github.com/elimu-ai/vitabu/blob/main/build.gradle
1. https://github.com/elimu-ai/vitabu/blob/main/app/build.gradle
## Development 👩🏽💻
During development, you can choose between 3 build types:
1. `debug`
2. `qa_test`
3. `release`
By default, both `debug` and `qa_test` are pointing to a webapp
[test server](https://github.com/elimu-ai/webapp/blob/main/INSTALL.md#test-server). And if you want
to run the webapp yourself on `localhost` while testing the Content Provider app, you can change
the return value of the `getBaseUrl` method in
[BaseApplication.java](app/src/main/java/ai/elimu/content_provider/BaseApplication.java):
```java
// return url;
return "http://192.168.xxx.xxx:8080/webapp";
```
Use the `ifconfig` or `ipconfig` to get your IPv4 address.
You will also have to enable http connections by adding the following file to
`app/src/main/res/xml/network_security_config.xml`:
```xml
```
And then adding it to [AndroidManifest.xml](app/src/main/AndroidManifest.xml):
```xml
[!IMPORTANT]
> When adding a new database `@Entity` (or modifying an existing one), you need to prepare a database
migration (SQL script) in
[`app/src/main/java/ai/elimu/content_provider/room/db/RoomDb.java`](app/src/main/java/ai/elimu/content_provider/room/db/RoomDb.java).
Follow these steps:
1. Add the new/modified `@Entity` to [`app/src/main/java/ai/elimu/content_provider/room/entity/`](app/src/main/java/ai/elimu/content_provider/room/entity/)
1. Add the entity's DAO interface to [`app/src/main/java/ai/elimu/content_provider/room/dao/`](app/src/main/java/ai/elimu/content_provider/room/dao/)
1. Include the DAO interface in [`app/src/main/java/ai/elimu/content_provider/room/db/RoomDb.java`](app/src/main/java/ai/elimu/content_provider/room/db/RoomDb.java)
1. Include the entity in the `entities` section of the `@Database` in [`app/src/main/java/ai/elimu/content_provider/room/db/RoomDb.java`](app/src/main/java/ai/elimu/content_provider/room/db/RoomDb.java)
1. Bump the `@Database` version in [`app/src/main/java/ai/elimu/content_provider/room/db/RoomDb.java`](app/src/main/java/ai/elimu/content_provider/room/db/RoomDb.java)
1. Build the code with `./gradlew clean build`
1. Open the new database schema generated at `app/schemas/ai.elimu.content_provider.room.db.RoomDb/.json`
- Under `entities`, find the matching `tableName` and copy its SQL script from the `createSql` property.
1. Open `RoomDb.java` and add a new method for the latest migration
- Paste the SQL script from the above JSON schema, and replace `${TABLE_NAME}` with the name of the table you created/modified.
- Include the migration in the `getDatabase` method in `RoomDb.java`.
1. To run the database migration, launch the application on your device.
1. To verify that your database migration ran successfully, look at the Logcat output and
ensure that there are no RoomDb errors:
```
2023-11-27 11:46:50.662 6124-13233 ai.elimu.c....RoomDb$18 ai.elimu.content_provider.debug I migrate (23 --> 24)
2023-11-27 11:46:50.663 6124-13233 ai.elimu.c....RoomDb$18 ai.elimu.content_provider.debug I sql: CREATE TABLE IF NOT EXISTS `LetterSound`
(`revisionNumber` INTEGER NOT NULL, `usageCount` INTEGER, `id` INTEGER, PRIMARY KEY(`id`))
```
> [!TIP]
> You can also use Android Studio's _Database Inspector_ to verify that the database
migration succeeded:
## Release 📦
To perform a release, follow these steps:
1. Create a new branch for the release
1. Remove `-SNAPSHOT`
- from the `versionName` in `app/build.gradle`
- from the `versionName` in `utils/build.gradle`
- from the `version` in `utils/build.gradle` under `publishing`
1. Commit the changes
1. Click "Draft a new release" at https://github.com/elimu-ai/content-provider/releases
1. Pick the new branch you created as the target branch
1. Create a new tag (e.g. `1.2.19`)
1. Choose a release title, and click "Publish release"
1. Ensure that the release appears at https://jitpack.io/#elimu-ai/content-provider with "Status: ok"
1. Prepare for next development iteration by bumping the version and adding `-SNAPSHOT`
- in the `versionCode` in `app/build.gradle`
- in the `versionName` in `app/build.gradle`
- in the `versionCode` in `utils/build.gradle`
- in the `versionName` in `utils/build.gradle`
- in the `version` in `utils/build.gradle` under `publishing`
1. Commit the changes
- Create a pull request for merging your branch into `main`
---
elimu.ai - Free open-source learning software for out-of-school children ✨🚀
Website 🌐
•
Wiki 📃
•
Projects 👩🏽💻
•
Milestones 🎯
•
Community 👋🏽
•
Support 💜