api: test: tools: web: webapp:

OpenMRS is a patient-based medical record system focusing on giving providers a free customizable electronic medical record system (EMR).

The mission of OpenMRS is to improve health care delivery in resource-constrained environments by coordinating a global community that creates a robust, scalable, user-driven, open source medical record system platform.

1. Build
   1. Prerequisites
   2. Build Command
   3. Deploy
2. Navigating the repository
3. Software Development Kit
4. Extending OpenMRS with Modules
5. Documentation
   1. Developer guides
   2. Wiki
   3. Website
6. Contributing
   1. Code
   2. Code Reviews
   3. Translation
7. Issues
8. Community
9. Support
10. License

OpenMRS is a Java application which is why you need to install a Java JDK.

If you want to build the master branch you will need a Java JDK of minimum version 8.

Install the build tool Maven.

You need to ensure that Maven uses the Java JDK needed for the branch you want to build.

To do so execute

mvn -version

which will tell you what version Maven is using. Refer to the Maven docs if you need to configure Maven.

Install the version control tool git and clone this repository with

git clone https://github.com/openmrs/openmrs-core.git

After you have taken care of the Prerequisites

Execute the following

cd openmrs-core
mvn clean package

This will generate the OpenMRS application in webapp/target/openmrs.war which you will have to deploy into an application server like for example tomcat or jetty.

For development purposes you can simply deploy the openmrs.war into the application server jetty via

cd openmrs-core/webapp
mvn jetty:run

If all goes well (check the console output) you can access the OpenMRS application at localhost:8080/openmrs.

Refer to Getting Started as a Developer - Maven for some more information on useful Maven commands and build options.

The project tree is set up as follows:

For rapid development of modules and the OpenMRS Platform code check out the awesome SDK at

https://wiki.openmrs.org/display/docs/OpenMRS SDK

OpenMRS has a modular architecture that allows developers to extend the OpenMRS core functionality by creating modules that can easily be added or removed to meet the needs of a specific implementation.

Before creating your own module go to the OpenMRS Module Repository and see if there is already a module for your specific use case. If so deploy and try it and if a functionality is missing join the developers of the module to add a feature.

If you haven't found what you were looking for refer to the Module - wiki to learn how you can create a new module.

If you want to contribute please refer to these resources

• Getting Started as a Developer
• How To Configure Your IDE
• How To Make a Pull Request

If you are looking for detailed guides on how to install, configure, contribute and extend OpenMRS visit

http://wiki.openmrs.org

If you are looking for more information regarding OpenMRS as an organization check

http://openmrs.org

Contributions are very welcome, we can definitely use your help!

OpenMRS organizes the privileges of its contributors in developer stages which are documented here.

Read the following sections to find out where you could help.

Check out our contributing guidelines, read through the Developer guides.

After you've read up 👓 grab an introductory issue that is Ready For Work.

You might not have the time to develop yourself but enough experience with OpenMRS and/or reviewing code, your help on code reviews will be much appreciated!

Read

https://wiki.openmrs.org/display/docs/Code Review

and get started with re-:eyes: pull requests!

We use

https://www.transifex.com/openmrs/OpenMRS/

to manage our translations.

The messages.properties file in this repository is our single source of truth. It contains key, value pairs for the English language which is the default.

Transifex fetches updates to this file every night which can then be translated by you and me on transifex website itself. At any time we can pull new translations from transifex back into this repository. Other languages like for ex. Spanish will then be in the messages_es.properties file.

If you would like to know how to help with translations see

http://openmrs.org/join-the-community/translate/

If you want help fix existing issues or you found a bug and want to tell us please go to

https://issues.openmrs.org

Talk to us on OpenMRS Talk

MPL 2.0 w/ HD © OpenMRS Inc.