Page Comparison

1. This document will help people setup their machine so that one can perform development on Bahmni.
2. Don't get intimidated. Be pro-active, ask questions on OpenMRS Talk, and take help whenever required. One step at a time, and you should be good.
3. This document was written for Mac OS X, but should be equivalent on Linux. Will need slightly different commands for Windows, but essentially the steps will be same. Windows users may use packages like WinSCP to connect to the virtual machine, create soft links, view/modify json files.

4. If you would like to contribute as a volunteer to Bahmni, and need some potential tasks to pick, please check out our Open Community Volunteer Board (or the newbie tickets). Also read Contributing to Bahmni for ways in which you can contribute (besides coding).

5. To submit code to Bahmni, you will need to follow the PR model, commonly used in most open source projects. If you are unfamiliar with this, please also read this before making any code changes locally.
6. Be respectful and friendly. 

First ensure that Bahmni Virtual Box (and Vagrant) are already installed and running on your machine. Follow steps mentioned here: Bahmni Virtual Box. Once you have vagrant box setup, then Bahmni will be running inside the vagrant box, but accessible from your host machine's browser using the URL https://192.168.33.10/home. Also, your code folder will be shared and editable from both the guest machine, and the host machine. This means, that you can now use your favourite IDE on your host machine to edit code, and compile and then you can run the changes from inside the Vagrant box.

FOR IMPLEMENTERS:

Note that these steps are needed ONLY IF you are going to modify EMR UI code, and do development on Bahmni product. If you only want to perform implementation specific changes, like changes to registration screen, create observation forms/templates, add fields to screen, etc, then you DO NOT need to setup the Development Environment. In that case, you only need to work with the implementation-config folder specific to your implementation, and modify only files inside that folder to see changes in the UI.

As an implementer, the files that you modify, should be then copied in /var/www/bahmni_config folder. Or you can alternatively, create a soft link where /var/www/bahmni_config points to your implementation-config folder so that changes you make to files in your implementation-config folder will immediately get reflected inside the vagrant box. The command to do that is:

# Soft Link bahmni_config to default-config folder
sudo ln -s /bahmni/default-config /var/www/bahmni_config

The installation of software development tools like Ruby, Node.JS, Maven, etc is only needed in case you plan to contribute to Bahmni EMR UI Code, or to Bahmni-Core / OpenMRS modules.

If you are new to Git/Github, please check out this video to understand Git/Github better: https://www.youtube.com/embed/LEkd3uOSAVc

gem install compass # you may need to use sudo to install Ruby gem compass ...

cd /Projects/bahmni
# clone the default configuration (some folks may choose their project specific config like jss-config)
git clone https://github.com/Bahmni/default-config.git
# clone Bahmni EMR UI project
git clone https://github.com/Bahmni/openmrs-module-bahmniapps.git
# clone the Bahmni Core backend project
git clone https://github.com/Bahmni/bahmni-core.git
# clone the common java utils used across the project
git clone https://github.com/Bahmni/bahmni-java-utils.git

# This command will clone all repositories of Bahmni to /tmp/src/bahmni path. It will create /tmp/src/bahmni path if its not already there
curl -s https://raw.githubusercontent.com/Bahmni/utilities/master/dev/clone-bahmni-repos.sh > /tmp/clone-bahmni-repos.sh
bash /tmp/clone-bahmni-repos.sh -d /tmp/src/bahmni

jq has to be installed to run the script above. Check this URL to install jq: https://stedolan.github.io/jq/download/

# Go into the UI directory
cd openmrs-module-bahmniapps/ui

# Install dependencies (Installed node dependencies into node_modules. UI dependencies are installed in node_modules/@bower_components and create a soft link to app/components).
yarn install

# Run tests, and check test coverage (required before the next step)
yarn clean test

# Build the application (into dist folder)
yarn default

You can see how a sample build output will look here on GoCD for Bahmni (use your GitHub account to authenticate).

When you link the folders, the script below will delete the current UI code from the Virtual Box. If you mess up the Virtual box, and need to reset it, just do a vagrant destroy and a vagrant up to restore it back. Of course, any changes you made inside the Virtual Box will get lost.

# Do this from inside the vagrant box (use 'vagrant ssh' to enter it)

# WARNING DO THIS ONLY IF YOU HAVE COMPILED THE UI CODE ALREADY ON YOUR MACHINE. ELSE YOUR EMR UI WON'T WORK
# IF YOU ARE ONLY DOING IMPLEMENTATION SPECIFIC UI CHANGES, THEN MAYBE YOU ONLY NEED TO LINK THE CONFIG FOLDER
# AND NOT THE bahmniapps FOLDER. IF YOU ARE UNSURE, PLEASE ASK SOMEONE FROM BAHMNI COMMUNITY.

# rename the original folder for backup
sudo mv /var/www/bahmniapps /var/www/bahmniapps-original

# (Option 1 - Simple) Create a link to your UI 'dist' folder
# - run the 'yarn default' build command (from your dev machine) to see your changes reflected
sudo ln -s /bahmni/openmrs-module-bahmniapps/ui/dist/ /var/www/bahmniapps

# (Option 2 - Advanced) Create a link to your UI 'app' folder
# - changes to HTML and JS files will be reflected immediately
# - run the 'yarn compass' command (from your dev machine) to see CSS changes reflected
sudo ln -s /bahmni/openmrs-module-bahmniapps/ui/app /var/www/bahmniapps
 
# Make the user bahmni owner of this new link
sudo chown -h bahmni:bahmni /var/www/bahmniapps

# Do this from inside the vagrant box (use 'vagrant ssh' to enter it)
 
# backup the original config folder
sudo mv -b /var/www/bahmni_config /var/www/bahmni_config-original
# Link your config folder (here we are linking the default-config folder)
sudo ln -s /bahmni/default-config /var/www/bahmni_config
# Make bahmni user the owner for this new link
sudo chown -h bahmni:bahmni /var/www/bahmni_config 

If you destroy your vagrant, and perform a vagrant up again, then these soft links will also be removed and you will need to run the link commands again.

/Projects/bahmni/openmrs-module-bahmniapps/ui/.

# if you took the simple linking approach
yarn default


# if you took the advanced linking approach
yarn compass

FOR IMPLEMENTERS:

Note that these steps are needed ONLY IF you are going to modify OpenMRS code or plan to write a new module.

If you have an older vagrant box (from atlas), then openmrs service may not exist. Instead the service name will be tomcat.

# Stop OpenMRS
sudo systemctl stop openmrs
 
# Copy the module to the modules directory
cp module_name.omod /opt/openmrs/modules
 
# For older installations prior to 0.81, copy to the older modules directory
cp module_name.omod /home/bahmni/.OpenMRS/modules
 
# Start OpenMRS
sudo systemctl start openmrs

# Go to the appropriate project directory
cd bahmni-core
 
# Build the module using maven
mvn clean install 

# Halt the virtual machine if it's already running
cd /Projects/Bahmni/bahmni-vagrant
vagrant halt

# Add this line in your Vagrantfile in the folder /Projects/Bahmni/bahmni-vagrant
config.vm.network :forwarded_port, guest: 8000, host: 8000

#Restart the virtual machine
vagrant up

# Log into your Vagrant box using ssh or PuTTY
cd bahmni-vagrant
vagrant ssh
 
# Restart openmrs in debug mode. By default, openmrs opens port 8000 for java debugging 
# CAUTION: It is to be noted that, alternate usage of systemctl and service command may lead to inconsistency of the openmrs service being started. 
(jdpa)
sudo service openmrs stop
sudo service openmrs debug


# Stop iptables so that host machine can connect to port 8000 successfully
sudo service iptables stop

# Optional. From your host machine. Run following command and check if port 8000 is open. 
nmap -v -sT 192.168.33.10