Welcome to OpenMRS! This guide will walk you through the steps to join the OpenMRS community and set up your system for development. You will also find some links to other resources that will help you learn and contribute to the OpenMRS project.
Table of Contents
Join the OpenMRS community
OpenMRS is a volunteer based community. We welcome anyone who is willing to learn and contribute. To join the community, follow these steps:
...
5. Look for Active Project teams or topics that might interest you
Consider joining a team of OpenMRS contributors working together on interesting topics or projects. You can find active Team-Based Projects in the OpenMRS Community at: https://wikiopenmrs.openmrsatlassian.orgnet/wiki/display/projects/Active+Projects
| Tip |
|---|
| If you need help choosing a project that’s right for you, reach out to our Director of Community Jennifer Antilla. |
6. Get edit privilege for wiki and issue tracker
Because of spammers, we must require this extra step before you can edit wiki pages or make any changes to JIRA tickets.
a. Create an account at OpenMRS helpdesk.
b. In the Summary text box, state that you would like to have edit access to wiki and JIRA.
c. Submit the helpdesk request.
Learn about developer stages
Based on your experience as an OpenMRS developer, you will be assigned a developer stage, from dev/1 up to dev/5, with increasing responsibilities and privileges.
To learn more, visit OpenMRS Developer Stages.
You can start by earning the /dev/null badge. When you're ready, take the quiz to earn /dev/1.There is no limit on how many times you can take the quiz.
Set up Git on your system
Git and GitHub work together so that the changes you make to the codes are tracked and incorporated correctly into OpenMRS code repositories. Follow the instructions below to sign up to GitHub and install GIt on your system.
- Create a GitHub account
You need to have a GitHub account to contribute to OpenMRS code.- Go to GitHub Sign Up page, and create a GitHub account.
- Add your GitHub username to your account profile in OpenMRS Talk.
- Download and install Git on your computer.
- Learn Git.
If you don’t already know how to use git, follow the instructions in Using Git, or Learn Git with Bitbucket. This is especially useful if you join a sprint or choose to share your module (we hope you do).
Set up development environment
Backend Development
To do development work for OpenMRS, you need to configure your system according the instructions below:
- Install Java SE 8.
- Install Maven.
- Install Docker.
- Install and configure IDE.
- Install OpenMRS SDK, and start an OpenMRS server.
To learn more about setting up and working with your development environment, follow the Step-by-Step Installation for Developers and How To Setup And Use Your IDE.
Frontend Development
See om.rs/o3docs
Create your first OpenMRS module
OpenMRS SDK makes the process of creating and deploying an OpenMRS module very simple. Follow this instruction to create your first OpenMRS module.
Start contributing! Find where you can help
Now that you’ve successfully set up your development environment, you can start to contribute to OpenMRS. Follow the Contribute as a Developer guide here:
| Auibutton | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Useful OpenMRS resources
OpenMRS wiki is the main resource where the community shares knowledge and documents the development process. Below is a list of wiki pages that can be useful for you to learn more about OpenMRS.
...
- More about OpenMRS
- OpenMRS Developer Guide is a rich resource for learning all aspects of OpenMRS development.
- Open MRS architecture and Data Model explain the technology and database structures underpin the OpenMRS applications.
- OpenMRS development screencasts on YouTube.
- OpenMRS SDK Step by Step Tutorial
- Unit Tests
- Conventions
- Code Review
- Code Review Checklist
- Simple Secure Coding Checklist
- Pull Request Tips
- How to Use OpenMRS API
- OpenMRS API
- OpenMRS REST API
- OpenMRS Frontend 3.0 for Developers
...