OpenMRS resources: Difference between revisions

← Older edit

OpenMRS resources (view source)

Revision as of 01:42, 21 February 2015

423 bytes removed , 9 years ago

→‎New Beginner Tickets

Anonymous user

imported>Hypotext

Revision as of 01:10, 29 January 2015 (view source) imported>Chrishay7 (→‎New beginner tickets) ← Older edit		Latest revision as of 01:42, 21 February 2015 (view source) imported>Hypotext (→‎New Beginner Tickets)
(22 intermediate revisions by 2 users not shown)
Line 10: Here is a [https://photos-5.dropbox.com/t/1/AAAAYoZcyOdcpW-q2FdsrAjD6waykEdpsOAzY8zpJGRlPQ/12/110243113/png/1024x768/3/1416646800/0/2/Capture%20d%27%C3%A9cran%202014-11-21%2015.34.34.png/8UfRRfbN2rbiRiztoMIyZ7wCf_uKZbgKEZjfTov0TBE screenshot]! (please ignore the French) = Relevant Links = [http://en.flossmanuals.net/_booki/openmrs-developers-guide/openmrs-developers-guide.pdf Developer's Guide]▼ Here are all the relevant links for future use:▼ ▲* [http://en.flossmanuals.net/_booki/openmrs-developers-guide/openmrs-developers-guide.pdf Developer's Guide] * [https://drive.google.com/folderview?id=0B47JK2xjSdD0WC1KUWlPSUU2MXM&usp=sharing Google Drive with VMs] Just download OpenMRS.tar.gz▼ * [https://docs.google.com/presentation/d/1Wa3TqRJSJgXLOt_rehlGa6NK6uh_2oW8Y04xjagywPY/edit?usp=sharing Wintersession Presentation]▼ ▲[https://drive.google.com/folderview?id=0B47JK2xjSdD0WC1KUWlPSUU2MXM&usp=sharing Google Drive with VMs] Just download OpenMRS.tar.gz ▲[https://docs.google.com/presentation/d/1Wa3TqRJSJgXLOt_rehlGa6NK6uh_2oW8Y04xjagywPY/edit?usp=sharing Wintersession Presentation] ~~= What to install before the workshop =~~ ~~If your computer has at least 10 GB of hard disk space free and at least 3 GB of RAM, it's recommended to download and install the following:~~ ~~Install VirtualBox: https://www.virtualbox.org/wiki/Downloads~~ ~~and Vagrant: http://downloads.vagrantup.com/~~ This allows you to use a virtual machine at the workshop that already has everything set up. Otherwise, you'll need to perform a manual installation. The manual installation guide can be found here: https://wiki.openmrs.org/display/docs/Getting+Started+as+a+Developer, but will be covered in more depth at the workshop. ~~= Getting OpenMRS up and running on your computer =~~ ~~The short version:~~ * Install git and IRC. * Manual setup (clone the code from GitHub) OR VM setup (follow VM instructions). ** VM setup is ''highly'' recommended. * Review the workflow of getting your code merged * Configure your git remotes. (if manual setup) * Compile the code. * Start the web server. * Go through the web app set up process. (if manual setup) * You should now have a running local version of OpenMRS on your machine! * If you want to get a feel for how one would fix a bug in the code, GOTO "OpenMRS bug walkthrough." If you want to fix an actual bug in the code, GOTO "new beginner tasks." ▲Here are all the relevant links: * [http://opensourceprinceton.wikidot.com/ OSAP wiki] (which has even MORE links!) * [http://opensourceprinceton.wikidot.com/openmrs-getting-started Background OpenMRS reading] (more links to check out in your free time) Line 53 ⟶ 27: * [https://github.com/hypotext/OpenMRS-dev-setup/wiki/Setting-up-git,-plus-workflow-tutorial Git + workflow tutorial] * [https://github.com/hypotext/OpenMRS-dev-setup/wiki/Running-the-OpenMRS-webapp-and-viewing-changes-in-code Running the webapp and viewing changes in code] ~~See steps below.~~ = Git setup = See [https://github.com/hypotext/OpenMRS-dev-setup/wiki/Setting-up-git,-plus-workflow-tutorial here]. (Not necessary for Full Virtual Machine 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 ~~Nicole~~Chris, Katherine, and/or ~~Danni~~Vibhaa about this setup.▼ 1) Partial Virtual Machine Setup▼ 2'''1) Full Virtual Machine Setup (Recommended)'''▼ * This setup uses a virtual machine that has the full OpenMRS setup ~~fully~~already configured for you. You ~~will~~would be ~~using~~working within the virtual machine to both write code and to run/test it. Features snapshots of the VM that allow you to very ~~quickly~~easily ~~skip~~rewind to ~~various stages of this demo in case you get stuck. Simply install VirtualBox and copy over the VM's file from~~ a ~~provided~~previous ~~flash drive. Then simply run the machine in VirtualBox and begin working~~state.▼ * Pros: Quick and easy to do. You ~~don't~~only need to install ~~anything~~VirtualBox onand ~~your machine (other than~~download the VM) to work on the project.▼ * Cons: Might be sluggish if you don't have enough RAM. * Requirements: ~~10GB~~7GB hard disk space and 3GB RAM (preferably 4+GB). Requires you to install VirtualBox and to download/copy over the VM.▼ Installation: Download and install [https://www.virtualbox.org/wiki/Downloads VirtualBox]. Download the [https://drive.google.com/file/d/0B47JK2xjSdD0ckZPdnUwaFJXOG8/view?usp=sharing Virtual Machine] (the OpenMRS.tar.gz file). Then extract the folder from this link. Add the downloaded machine in VirtualBox (Machine->Add Machine and navigate to the OpenMRS.vbox file within the folder extracted from the VM link). Install the VirtualBox Extension Pack from the previous VirtualBox link. If working on the sample bug, click on snapshots in the top right of the VirtualBox window and restore the top snapshot. Then just run the machine and begin! ▲1'''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. * Pros: Allows you to use your preferred text editor/work environment. * Pros: Quickest and easiest to do. * Cons: Less intuitive of what's going on unless you are very comfortable with working from the command line. * 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/tree/express-setup . Issue this command to clone it to your machine: Line 75 ⟶ 59: 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. * 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. = Sample Bug Walkthrough = Before working on a current bug, you might like to try completing [https://openhatch.org/wiki/OpenMRS_sample_bug the walkthrough of this older one] in order to get a feel for the workflow. = General Workflow ~~for a~~ = git: version control system.▼ See [https://github.com/hypotext/OpenMRS-dev-setup/wiki/Setting-up-git,-plus-workflow-tutorial here].▼ ▲git: version control system. GitHub: visual interface for git. Lets you view repositories, pull requests (requests from other people to add original code), etc. online. Line 107 ⟶ 83: * Repeat * Hopefully get your pull request merged into upstream! [https://github.com/openmrs/openmrs-core/pull/1160 Looks like this]. ▲~~See~~ [https://github.com/hypotext/OpenMRS-dev-setup/wiki/Setting-up-git,-plus-workflow-tutorial See here for a more detailed walkthrough]. = New Beginner Tickets = * Pair programming is great! If you're working on one of these, please tell Chris, Katherine, and/or Vibhaa (or edit the wiki and ~~put~~add your name next to it! ). * [https://issues.openmrs.org/browse/TRUNK-3274 TRUNK-3274] Voided person addresses and names should be ignored by the short patient form validator Line 120 ⟶ 98: * [https://issues.openmrs.org/browse/TRUNK-4575 TRUNK-4575] TestData - Duration Unit not usable * [https://issues.openmrs.org/browse/TRUNK-3746 TRUNK-3746] Error adding a ConvSet in a second form schema * [https://issues.openmrs.org/browse/TRUNK-4473?filter=10068 TRUNK-4473] Form Resource (Long-Text) causes error with binary file upload List of all intro tickets: * https://tickets.openmrs.org/secure/IssueNavigator.jspa?mode=hide&requestId=10068