This is a very basic module which can be used as a starting point in creating a new module.
You will need to have Java 1.6+ and Maven 2.x+ installed. Use the command 'mvn package' to compile and package the module. The .omod file will be in the omod/target folder.
Alternatively you can add the snippet provided in the Creating Modules page to your omod/pom.xml and use the mvn command:
mvn package -P deploy-web -D deploy.path="../../openmrs-1.8.x/webapp/src/main/webapp"
It will allow you to deploy any changes to your web resources such as jsp or js files without re-installing the module. The deploy path says where OpenMRS is deployed.
This project uses Spotless for code formatting. Spotless is embedded in the build process, so when you run mvn clean package, Spotless will automatically format your code according to the project's style guidelines.
If you want to run Spotless separately, you can use the following Maven commands:
To apply the formatting:
mvn spotless:apply
This will automatically format your code according to the project's style guidelines. It's recommended to run this command before committing your changes.
To check if your code adheres to the style guidelines without making any changes, you can run:
mvn spotless:check
If this command reports any violations, you can then run mvn spotless:apply to fix them.
Remember, in most cases, you don't need to run these commands separately as Spotless will run automatically during the build process with mvn clean package.
- Build the module to produce the .omod file.
- Use the OpenMRS Administration > Manage Modules screen to upload and install the .omod file.
If uploads are not allowed from the web (changable via a runtime property), you can drop the omod into the ~/.OpenMRS/modules folder. (Where ~/.OpenMRS is assumed to be the Application Data Directory that the running openmrs is currently using.) After putting the file in there simply restart OpenMRS/tomcat and the module will be loaded and started.