The project has been selected as a candidate for Google Summer of Code 2016. Please visit the project's page for more details: https://wiki.openmrs.org/display/projects/OpenMRS+Android+Client+-+GSoC+2016
For a detailed description of all work done during GSoC 2016, please checkout the GSoC_2016.md file.
#Description The goal of this project is to provide OpenMRS 2.x client for Android devices. The app is designed to cover most of the functionality of the web application including registering patients, taking visit notes, capturing vitals, etc. The app will communicate with OpenMRS using REST. It will support working off-line (without network connection) with a chosen subset of patients. The database on the device will be encrypted and password protected to secure patient data. For more information, including screenshots of the client, visit https://wiki.openmrs.org/display/projects/OpenMRS+2.x+Android+Client
Before creating pull request run code review tools, PMD & Checkstyle, and tests.
We are following Google's MVP sample for this application development.
As of February 2016, this project has been migrated to gradle to work successfully with Android studio. Steps to set up:
- Clone the project
- From the Android Studio menu select File > New > Import Project. Alternatively, from the Welcome screen, select Import project.
- Navigate to the folder when you have cloned this repo and select the build.gradle file inside it. Select import.
- Done! Wait for dependencies to load and download from Maven, and you are ready to go!
- Make sure that you have the latest SDK and build tools downloaded, as we will always build against the latest release.
[In-depth tutorial] (https://github.com/codepath/android_guides/wiki/Getting-Started-with-Gradle)
If you have been building on Eclipse before this change was made, you have two options:
A. Re-clone, import in Studio and manually change the files if any done after February 2016. This is easier and recommended.
B. Open Android Studio, import project and select your openmrs project. Next, import module and in this step, import the odkcollect module. Set it as your project dependency. As a final step, add the lines useLibrary 'org.apache.http.legacy' in odkcollect/build.gradle under android{ }.
Note:
- If you are working behind a proxy, check this to get things working.
- To start development on local server, type http://10.0.2.2:8080/openmrs (for Android Studio AVD) or http://10.0.3.2:8080/openmrs (for Genymotion) as URL.
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.
- Login screen
- Read-only access to patient details (full name, birthdate, address), vitals and visits.
- Downloading and storing patient data in the encrypted database on the device See more in JIRA
- Starting/stopping visits
- To Be Determined See more in JIRA
- JIRA https://issues.openmrs.org/browse/AC/?selectedTab=com.atlassian.jira.jira-projects-plugin:summary-panel
- Sprint board https://issues.openmrs.org/secure/RapidBoard.jspa?rapidView=60
- Dashboard https://issues.openmrs.org/secure/Dashboard.jspa?selectPageId=12851
- Repository https://github.com/openmrs/openmrs-contrib-android-client
- CI https://travis-ci.org/openmrs/openmrs-contrib-android-client
- Google Play https://play.google.com/store/apps/details?id=org.openmrs.mobile