Skip to content

Latest commit

 

History

History
363 lines (305 loc) · 17.8 KB

README.md

File metadata and controls

363 lines (305 loc) · 17.8 KB
Raw

Logo

OpenMRS Android Client

Build Status Travis Build Status AppVeyor Demo Server GitHub version Codacy Badge codecov 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 page

GSoC 2019

This project was also selected for Google Summer of Code 2019. More details can be found on the Project Wiki Page.

It was 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. These can be applied to Android Studio by following the steps given below.

  1. Install Eclipse Code Formatter plugin in Android studio I. Go to Settings > Preferences > Plugins II. Select Marketplace and searh for the plugin by name. Then install it
  2. Copy the required XML
  3. Go to Settings > Eclipse Code Formatter and import the XML created in previous step
  4. Now go to Editor > Code Style in the same window
  5. Select Java in the menu on left and update values in Imports as shown in below picture Java:Imports settings
  6. Now select XML in the menu on left and update values in Tabs and Indents tab as shown in below picture XMLOther setings

Please follow the below instructions while contributing:

  1. When project is opened with Android Studio, go to File > Settings > Editor > Code Style
  2. Select Project from the Scheme dropdown
  3. Make sure that hard wrap is set to 125 for Java and XML language settings.

Model pattern

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

HTTP call debugging

In order to debug HTTP calls, we have integrated Chuck Library (a GUI based open source library) to track network calls. Apps using Chuck will display a notification showing a summary of ongoing HTTP activity. Tapping on the notification launches the full Chuck UI.

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 to the client is (https://demo.openmrs.org/openmrs/). In case the demo server fails to respond, you can use oher alternate servers provided here.

Demo Username: admin
Demo Password: Admin123

Releasing [Collaborators only]

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

To release the application, make sure to do these steps in order:

  1. Update the version variable in versions.gradle prior to the release.
  2. Update the Release notes section.
  3. Update the release notes text file to publish in the Play store. Ideally change the wording so that normal end users understand.
  4. Now commit with the title Release <version number here> to the master branch.
  5. Tag the commit, using the version as the tag name. Make sure CI is green!
  6. Go to the releases page 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. Be sure to bump unfinished issues to the next due version.
  7. Go to JIRA's releases page, click on the three-dots on the right, and hit Release.
  8. Post a new Talk thread and describe what is changed or improved in the release.

Release Notes

Version 2.9.0

  1. Updated UI for different activities (#787, #785, #803, #806, #808, #809)
  2. Added repository layer for different activity layer (#784, #791, #797, #799)
  3. Migrated codebase to kotlin (#794, #802, #811, #814)
  4. Removed unused resources (#788, #805)
  5. Created offline support for Allergy module (#786)
  6. Create allergy based on server configuration (#796)
  7. Allergy can be updated as per server settings (#798)
  8. Allergy can be deleted in online/offline mode (#793)
  9. Overloaded methods of AppDataBase Helper class (#789)
  10. Removed Collapsable bar in provider dashboard (#800)
  11. Removed unnecessary restAPI param passing to the repository (#792)
  12. Migrated Chart ListAdapter to RecyclerView (#807)
  13. Fixed app restarts on downloading concepts (#795)
  14. Fixed crash at admission form by using live data (#804)
  15. Fixed Release version blocker (#790)
  16. Added possible NPE checks at PatientComparator (#810)

Version 2.8.4

  1. Create admission form (#696)
  2. Migrate Java code to Kotlin (#757, #766, #765, #764, #767)
  3. Fix Floating Action Button bugs (#763, #769)
  4. Add crop image feature in patient registration (#768)
  5. Update UI to follow material design (#770, #778, #777)
  6. Upgrade dependencies to the latest versions (#772)
  7. Add expandable FAB for provider dashboard (#773)
  8. Add empty active visits view (#771)
  9. Mark patient deceased using coded response (#774)
  10. Removed swipe actions in provider dashboard (#775)
  11. Fix the reverse flipping bug in patient dashboard (#779)
  12. Add allergy tab to fetch allergies from server (#780)
  13. Finish migration from ActiveAndroid to Room (#781, #783)
  14. Add repository layer in visit dashboard (#782)

Version 2.8.3

  1. Fixed critical bugs (#718, #721, #722, #730, #734, #741, #742)
  2. Add showcase view for manage providers module (#720)
  3. Continue creating Room DAOs (#727, #736, #739, #740, #735, #738)
  4. Refined custom dialog box in add patient activity (#731)
  5. Start visit is disabled in offline mode (#729)
  6. Add option for 'Unknown' patients when registering (#733)
  7. Change main font to Roboto (#745)
  8. Fixed app crash on lower API devices (#749)
  9. Avoid keyboard blocking SnackBar messages (#747)
  10. Change endpoint debugger to Chucker to avoid crash (#750)
  11. Better localization (#723)
  12. Fix ill formed provider fields (#751)
  13. UI overhaul, better compliant with Material UI guidelines (#744, #746, #743, #753, #759, #761, #760)
  14. Migrate Java code to Kotlin (#752, #758, #756)
  15. Add offline support for provider module (#748)
  16. Double back press to exit the app (#762)

Version 2.8.2

  1. Add contribution guidelines to the repository (#671, #662)
  2. Removed unused resources, decreasing APK size (#669)
  3. Removed hardcoded strings (#673)
  4. Dashboard now responds to change in app theme (#661)
  5. Add language translation in hindi (#650)
  6. Create Room Data Access Objects (DAOs) (#670, #659, #682, #657, #662)
  7. UI fixes in register patient screen (#686)
  8. Added reset button (#692)
  9. Improved login and fragment dialog button design (#672)
  10. Improve PatientDetailFragment UI (#700)
  11. Fix app crash on entering values in email or password text fields (#691)
  12. Add City and State selector using Google Places API (#694)
  13. Fix crash at register patient activity (#717)
  14. Fix context-related errors (#713, #716)
  15. Add swipe to refresh feature in relevant screens (#701)
  16. Add Contact Us screen (#710)
  17. Migrate POJO classes to Kotlin (#675, #719)
  18. Add validation to HIV status in Visit Notes screen (#698)

Version 2.8.1

Summary:

  1. Fix window leakage error when viewing patient details
  2. Fix various performance issues
  3. Integrate leak canary for debug builds
  4. Add a splash screen
  5. Add intro slides for first time users
  6. Set a code style
  7. Fix broken unit tests

Version 2.8.0

Summary:

  1. Add Dark mode to the app
  2. Provider management: admins can now find, add, edit and delete providers
  3. Refactor Repository names.
  4. Fix details not showing when searching patients

Version 2.7.4

Summary:

  1. Make UI more consistent and follow more of the material design specs
  2. Implement Initial Provider Management
  3. Remove redundant type cast
  4. Add Floating Action Button in patient's details tab

Version 2.7.3

Summary:

  1. Remove Apache HTTP API Client library
  2. Patient now extends Person
  3. Make Search primary function for Find Patients
  4. Revamp Settings Page (new material design!)
  5. Integrated android snooper for debugging purpose

Version 2.7.2

Summary:

  1. Added Kotlin dependency to app level build.gradle file
  2. Added release folder to gitignore
  3. Initialized SQLCipher, made app 64-bit compliant
  4. Changed Gradle to latest version
  5. Fixed Play Publisher not publishing to Play store

Version 2.7.1

Summary:

  1. Fixed bug on showing/hiding the password during login
  2. Visit Notes can now correctly show details
  3. Use Codecov as the code coverage tool
  4. Add privacy policy link to Settings page
  5. Re-developed OpenMRSLogger - faster loading times
  6. Most buttons now follow the material design guideline
  7. User is now taken back to the completed form on clicking cancel during registration
  8. Replace country selection with a country picker
  9. Setup Android Room and create entities
  10. Add Contextual Action Bar in Synced Patients to delete multiple patients at once

Version 2.7.0

Summary:

  1. Implement RxJava in DAOs and migration to AndroidX
  2. Pick patient photo when registering
  3. Login form improved and doesn't require login locations when no locations are configured
  4. Add data validation when registering patients
  5. Encrypted the database with BCrypt, derived from username and password
  6. Show toasts when toggling sync button and fixed crash when updating non-synced patient
  7. Saving user input when device is rotated, or when app instance is lost
  8. Added a Privacy Policy
  9. Renewed GitHub API Key
  10. Set a Custom Path to look for the Release APK

Version 2.6.2

Summary:

  1. Add patient picture
  2. Bug Fixes

Version 2.6.1

Summary:

  1. Handle camera and storage permissions manually
  2. Bug Fixes

Version 2.6.0

Summary:

  1. Fixed patient selection when changing orientation
  2. More user-friendly register form
  3. Added unit tests
  4. Filter patients by given/middle/family names at the same time
  5. Get data from DB in background task
  6. Lint check to GitHub Pull Requests

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.9+ (next releases)

Goals:

  1. Material UI design
  2. Integrate more components of the webapp to the client
  3. Password reset via email
  4. Replace Java code with Kotlin
  5. Migrate ActiveAndroid SQL library to room library

User Manual

Check this link for the manual: Version 2.9+

License

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

Resources