OpenMRS resources: Difference between revisions

Content added Content deleted
imported>Chrishay7
imported>Chrishay7
Line 61: Line 61:


= OpenMRS setup =
= OpenMRS setup =
⚫
It's highly recommended you choose one of the VM based setups. If that's not possible (often because of memory constraints) 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 Chris, Katherine, and/or Vibhaa about this setup.
⚫
1) Partial Virtual Machine Setup


⚫
'''1) Full Virtual Machine Setup (Recommended)'''
⚫
* This setup uses a virtual machine that has the full OpenMRS setup already configured for you. You would be working within the virtual machine to both write code and to run/test it. Features snapshots of the VM that allow you to very easily rewind to a previous state.
⚫
* 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 VM, which may have a slight learning curve.
⚫
* Requirements: 7GB hard disk space and 3GB RAM (preferably 4+GB). Requires you to install VirtualBox and to download/copy over the VM.



⚫
'''2) 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.
* 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: Allows you to use your preferred text editor/work environment.
* 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)
* 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.
* Requirements: 10GB of hard disk space and 3GB RAM. Requires you to install VirtualBox and Vagrant.
Line 75: Line 86:
before issuing "vagrant up".
before issuing "vagrant up".



⚫
2) Full Virtual Machine Setup
⚫
'''3) Manual 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 VM, which may have a slight 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.
* This setup fully configures your machine to be able to contribute to OpenMRS.
* Pros: Lowest hardware requirements
* Pros: Lowest hardware requirements
* Cons: Slowest and most error prone setup (especially if you run Windows)
* 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.



= Sample Bug Walkthrough =
= Sample Bug Walkthrough =
Retrieved from "https://wiki.openhatch.org/wiki/OpenMRS_resources"