https://github.com/dhis2/dhis2-android-sdk

SDK for building Android apps for DHIS 2
https://github.com/dhis2/dhis2-android-sdk

android dhis2 java

Last synced: 7 days ago
JSON representation

SDK for building Android apps for DHIS 2

• Host: GitHub
• URL: https://github.com/dhis2/dhis2-android-sdk
• Owner: dhis2
• License: bsd-3-clause
• Created: 2015-02-19T11:12:30.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2024-10-29T14:32:27.000Z (17 days ago)
• Last Synced: 2024-10-29T17:54:45.196Z (17 days ago)
• Topics: android, dhis2, java
• Language: Kotlin
• Size: 64.2 MB
• Stars: 40
• Watchers: 29
• Forks: 63
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# DHIS2 Android SDK

[![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.hisp.dhis/android-core/badge.svg)](https://maven-badges.herokuapp.com/maven-central/org.hisp.dhis/android-core)

[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=dhis2_dhis2-android-sdk&metric=coverage&branch=master)](https://sonarcloud.io/summary/new_code?id=dhis2_dhis2-android-sdk&branch=master)

[![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=dhis2_dhis2-android-sdk&metric=ncloc&branch=master)](https://sonarcloud.io/summary/new_code?id=dhis2_dhis2-android-sdk&branch=master)

## Introduction

DHIS2 Android SDK is a library that abstracts the complexity of interacting with DHIS2 web api. It aims to be an starting point to build Android apps for DHIS2, covering some tasks that any Android app should implement, like metadata and data synchronization.

Main goals:

- **Abstract DHIS2 web api**. There is no need to perform api queries against the server. The SDK includes methods to interact with the web api.

- **Work offline**. It implements a simplified version of DHIS2 model that is persisted in a local database (SQLite). It ensures that all the metadata required to perform data entry tasks is available at any time to build the data entry forms. Data is saved locally and upload to the server when connectivity is available.

- **Ensure DHIS2 compatibility**. It encapsulates the changes between DHIS2 versions so the app does not have to care about them. In case the SDK introduces some changes to accommodate a new DHIS2 version, the app can safely detect these changes at compile-time.

## Documentation

Developer-oriented documentation can be found in [Documentation section](https://docs.dhis2.org/en/develop/developing-with-the-android-sdk/about-this-guide.html) in DHIS2 web. It is intended to be used by developers.

## Examples

Code examples can be found in the [Android Skeleton app](https://github.com/dhis2/dhis2-android-skeleton-app). This app contains different branches showing different use cases of the SDK.

## Community

Community support can be found in [Android SDK Development](https://community.dhis2.org/c/development/sdk-android-development) category in the community portal. Any feedback on the SDK will be highly appreciated.

To report bugs or request new features, there is project in DHIS2 Jira named [ANDROSDK](https://jira.dhis2.org/projects/ANDROSDK/issues). Please do not hesitate to create an issue with your request.