Java Shell
Clone or download

README.md

Logo

OpenMRS Android Client

Build Status Travis Build Status AppVeyor Demo Server GitHub version Codacy Badge IRC

Table of Contents

Description

The purpose of this project is to provide an OpenMRS 2.x client for Android devices. The app is designed to cover most of the functionality currently on the web application. The app communicates with OpenMRS instances using REST. It supports working offline (without network connection). The database on the device is encrypted and password protected to secure patient data. For more information on the client, visit https://wiki.openmrs.org/display/projects/OpenMRS+2.x+Android+Client

Key Features

  • Connect to OpenMRS server and sync all data
  • Register and Edit patients
  • Record Visits and Encounters
  • View patient data (Details, Diagnoses, Visits, and Vitals)
  • Offline access

Screenshots

Login Dashboard Register Patient

GSoC 2017

The project has been selected as a candidate for Google Summer of Code 2017. Please visit the Project Wiki Page for more details.

The project was also a part of GSoC 2016, the details of which can be seen in the GSoC_2016.md file.

Development

We use JIRA to track issues and monitor project development. Refer to this link to view all issues and project summary: Android Client JIRA To get started contributing, try working on introductory issues in JIRA and check out OpenMRS Pull Request Tips. Also, before creating a pull request, please run code review tools (Lint) and all tests.

Code Style

The coding conventions used by OpenMRS are outlined here.

Model pattern

We are following Google's MVP sample for this application's development.

Quick Start

As of February 2016, this project has been migrated to gradle to work successfully with Android Studio.

Steps to set up:

  1. Fork the repository and clone your fork.
  2. From the Android Studio menu select File > New > Import Project. Alternatively, from the Welcome screen, select Import project.
  3. Navigate to the folder where you have cloned this repo and select the build.gradle file inside. Select "Import".
  4. Done! Wait for dependencies to load and download from Maven, then you're ready to go!
  5. Make sure that you have the latest SDK and build tools downloaded, as we always build against the latest release.

In-depth tutorial

Note:

Demo Server

The demo test server dedicated for the client is (https://demo.openmrs.org/openmrs/).

Demo Username : admin
Demo Password : Admin123

Releasing

We follow the sprint model for development. Read more about it here: OpenMRS Sprints.

In order to release the application, go to releases and click the Draft a new release button. It will create a new version tag in the repository and build the app. The tag name will be used as the version number for this release.

If you want to release a new major or minor version, please be sure to update the applicationVersion variable in build.gradle prior to the release.

Release Notes

Version 2.6

Summary:

  1. Add patient picture
  2. More user friendly register form
  3. Filter patients by given/middle/family names at same time
  4. Get data from DB in background task
  5. Lint check to GitHub Pull Requests
  6. Fixed bugs

Version 2.5

Summary:

  1. Log in offline
  2. Coded fields in forms
  3. Edit forms
  4. Edit patients
  5. Lots of bug fixes

Version 2.4

Summary:

  1. Added merging patients registered offline
  2. Find Patient storyboard refactoring
  3. Fixed bugs

Objectives

Version 2.7 (next release)

Goals:

  1. Users can see and copy logs
  2. Unsubscription in presenters
  3. Infinite scrollability for last viewed patients activity
  4. Visualize progress dialog on a new visit

User Manual

Check this link for the manual: Version 2.x

License

This project is licensed under the OpenMRS Public License, see the copyright file for details.

Resources