Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Replace link with the right one

This guide is for anyone who wants to setup their development environment to start working with OpenMRS. 

OpenMRS Hackathon Registration

  1. Create a OpenMRS ID if you do not have one. This is used for accessing OpenMRS JIRA, Wiki (Including editing this page).
  2. Once you have your OpenMRS ID please make sure you add yourselves to the participant list.
  3. Have a Github account. You need this if you want to check in code.

Technical Prerequisites (Make sure you do this before the day of hackathon)

Make sure you have the following installed on your laptop before you get started.

  1. Java JDK 7. This also work with JDK 8, but officially is not supported yet. 
  2. Git for checking out source code. 
  3. Install Maven on your local machine. This is used for building OpenMRS. 
  4. Optional - Docker Toolbox. Docker is only used for running mysql at the moment. You may choose to skip this step and install MySQL directly. 
  5. Optional (If you don't have docker) - Install Mysql on your local machine. Make sure you set the root password for this MySQL and remember it.  You will need this later to run OpenMRS.
  6. Intellij or Eclipse IDE for Java EE Developers is the recommended Java development environment. But you can also use Intellij if you prefer that. 
  7. Create a OpenMRS ID if you do not have one. This is used for accessing OpenMRS JIRA, Wiki (Including editing this page).
  8. Once you have your OpenMRS ID please make sure you add yourselves to the participant list.
  9. Have a Github account. You need this if you want to check in code can be used as the IDE for development. Make sure you have one of them
  10. Follow the instruction instructions below to setup OpenMRS SDK and try to get a running application before the day of hackathon. This will help a lot in terms of saving time as the installation usually takes about an hour. 

Optional 

  1. Play around with the openmrs demo server  (admin/Admin123) .
  2. Quick functional overview of OpenMRS is available here. (Also includes a QA site to play around with OpenMRS).
  3. If you would like to get quick technical overview of OpenMRS architecture take a look here
  4. Join the email group Bahmni-Hackathon-Dallas@googlegroups.com if you are interested in getting email updates about the hackathon.
  1. couple of hours. 

Setting up Development Environment

If you want to install openmrs the traditional way you can follow the link here. But we recommend using the OpenMRS SDK for the hackathon because it makes installing easier. Make sure you do this before the hackathon because it takes around half an hour on a good internet connection to download all the dependencies. 

...

serverId is the server name under which the server would be installed.  


code
Code Block
language
powershell
themeDJangolanguagepowershell
titleCreate a OpenMRS server - Local MYSQL
#Make sure you substitute your mysql root password into the command before you run it.
mvn openmrs-sdk:setup -DserverId=openmrs -Dversion=2.3 -DdbDriver=mysql -DdbUri="jdbc:mysql://localhost:3306/openmrs?autoReconnect=true&sessionVariables=storage_engine=InnoDB&useUnicode=true&characterEncoding=UTF-8" -DdbUser=root -DdbPassword=<YOUR_ROOT_PASSWORD>

...

Code Block
languagetext
Caused by: java.sql.SQLException: Access denied for user 'test'@'localhost' (using password: YES)

 


Check out the the openmrs application at http://localhost:8080/openmrs

...

Congrats you are done with the installation. The username and password to login to OpenMRS would be admin/Admin123. You should be able to see the OpenMRS home page which would look like the following.


Make sure you have all you need ahead of your first hackathon by reviewing this quick Checklist for Hackathon

Whats NEXT

Find a story/ticket to work on here. Pair with someone if possible. 

...

OpenMRS SDK has much more features that what is listed here. Refer to the guide OpenMRS SDK

Optional 

  1. Play around with the openmrs demo server  (admin/Admin123) .
  2. Quick functional overview of OpenMRS is available here. (Also includes a QA site to play around with OpenMRS).
  3. If you would like to get quick technical overview of OpenMRS architecture take a look here
  4. Join the email group Bahmni-Hackathon-Dallas@googlegroups.com if you are interested in getting email updates about the hackathon.
  1. Demo server(admin/Admin123) – http://demo.openmrs.org/openmrs/login.htm
  2. Wiki – https://wikiopenmrs.openmrsatlassian.orgnet/wiki/display/docs/Homehttps://wiki.openmrs.org/display/docs/Getting+Started+as+a+
  3. Getting started as a developer - Getting Started as a Developer
  4. https://wikiopenmrs.openmrsatlassian.orgnet/wiki/display/docs/Step+by+Step+Installation+for+Developers
  5. OpenMRS SDK – https://wikiopenmrs.openmrsatlassian.orgnet/wiki/display/docs/OpenMRS+SDK
  6. Functional Overview can be found here.

Troubleshooting Tips

Forgot your mac MYSQL root password - Follow the instructions in the link here to reset it. 

...

mvn openmrs-sdk:run -DserverId=test