Wiki Spaces

Documentation
Projects
Resources

Get Help from Others

Q&A: Ask OpenMRS
Discussion: OpenMRS Talk
Real-Time: IRC Chat | Slack

Documentation

Page tree
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

This page will briefly discuss the development workflow for developing Open Web Apps. For a description of what Open Web Apps are, see the wiki page. Much of this document is copied from and inspired by the Developing an HTML+JS Open Web App Quickly wiki page.

1. Setup OpenMRS

In order to develop Open Web Apps, you will need an OpenMRS server running locally. The three ways to do this are described below.

Standalone

The quickest and easiest way to do this is to download the latest standalone server from the OpenMRS downloads page. You will need Java 1.7+ to run the standalone server. Once it's downloaded, extract the ZIP archive and run the .jar file either by double clicking it or executing the following command:

Running the OpenMRS standalone server
java -jar openmrs-standalone.jar

The first time you run the server you will be asked if you want to insert dummy data into the system. This is recommended if you want some data to play with.

SDK

Another easy way to run an OpenMRS server is to use the OpenMRS SDK. To use this method you must have Java 1.7+ Maven 3+ installed. To install and configure the OpenMRS SDK, run the following:

Installing the OpenMRS SDK
mvn org.openmrs.maven.plugins:openmrs-sdk-maven-plugin:setup-sdk

To create a new OpenMRS Platform server, run the following:

Creating a Platform Server
 mvn openmrs-sdk:setup-platform -DserverId=platform -Dversion=1.11.5

Finally, navigate to the server directory (probably ~/openmrs/platform) and run:

Running a Platform Server with the SDK
mvn openmrs-sdk:run

Enterprise

The enterprise install is usually meant for production environments, and involves installing MySQL and Tomcat manually, then downloading the OpenMRS Platform WAR file from the OpenMRS downloads page and deploying it to Tomcat. See the full documentation here.

Docker

TODO

2. Scaffold Open Web App

A boilerplate Open Web App along with some associated build (Gulp) and package management (Bower) tooling can be scaffolded use the Yeoman OpenMRS OWA generator. You will need NodeJS 4+ installed to do this. See the install instructions here.

Once you have NodeJS installed, you need to install Yeoman, Gulp and Bower as follows:

Install OWA Generator Dependencies
npm install -g yo gulp bower

You can then install the generator:

Install OWA Generator
npm install -g generator-openmrs-owa





  • No labels