OpenMRS resources: Difference between revisions

1) Partial Virtual Machine Setup

* This quick setup allows you to communicate with a virtual machine (VM) that has all OpenMRS related setup requirements already installed. You will be working in your machine and running/testing the code by using the command line to control the VM.

* Pros: Quickest and easiest to do.

* Cons: Harder to debug and less stable if you continue working on OpenMRS (if future releases complicate the setup, it'll be much harder to fix yourself)

* Requirements: 10GB of hard disk space and 3GB RAM. Requires you to install VirtualBox and Vagrant.

* Once VirtualBox and Vagrant are installed, follow the rest of the setup in the README here: https://github.com/cpschuster/OpenMRS-dev-setup. Issue this command to clone it to your machine:

git clone -b express-setup https://github.com/cpschuster/OpenMRS-dev-setup

Then follow the "Happy Path Usage Instructions" in the README.

Note: If you've ever used the express setup before, you'll want to do

vagrant box remove OpenMRS-dev-setup-clone

before issuing "vagrant up".

2) Full Virtual Machine Setup

* This setup uses a virtual machine that has the full OpenMRS setup fully configured for you. You will be using the virtual machine to both write code and to run/test it. Features snapshots of the VM that allow you to very quickly skip to various stages of this demo in case you get stuck. Simply install VirtualBox and copy over the VM's file from a provided flash drive. Then simply run the machine in VirtualBox and begin working.

* Pros: Quick and easy to do. You don't need to install anything on your machine (other than the VM) to work on the project.

* Cons: In order to not need anything else configured on your machine, you'll be using the setup in the VMm, which may have a learning curve.

* Requirements: 10GB hard disk space and 3GB RAM (preferably 4+GB). Requires you to install VirtualBox and to download/copy over the VM.

3) Manual Setup

* This setup fully configures your machine to be able to contribute to OpenMRS.

* Pros: Lowest hardware requirements

* Cons: Slowest and most error prone setup (especially if you run Windows)

It's highly recommended you choose one of the VM based setups. If that's not possible or if you'd simply prefer to do the manual setup, follow the guide here: https://wiki.openmrs.org/display/docs/Getting+Started+as+a+Developer and make sure to talk to Nicole and Danni about this setup.