Skip to content
Open Web Application that manages Add Ons for OpenMRS
JavaScript CSS Other
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
app
tests
.babelrc
.bowerrc
.eslintignore
.eslintrc
.gitignore
.hound.yml
.travis.yml
LICENSE
README.md
bintray.json
bower.json
deploy.sh
package.json
server.babel.js
webpack.sample.config.js

README.md

Build Status Coverage Status Codacy Badge

OpenMRS

OpenMRS Add Ons Manager

This repository contains the openmrs-addOnManager OpenMRS Open Web App.

The OpenMRS Add Ons Manager is a tool used for uploading, listing, and deleting existing OWAs and modules.

For further documentation about OpenMRS Open Web Apps see the wiki page.

Development

Local Setup Instructions

# Get the project
git clone https://github.com/openmrs/openmrs-owa-addonmanager.git

# Move into the project directory
cd into openmrs-owa-addonmanager

# Install the dependencies
npm install

# Copy the webpack configuration from webpack.config.sample.js to webpack.config.js
cp webpack.sample.config.js webpack.config.js

# Locate the 'appdata/owa' directory and type the following command to get the path to the 'appdata/owa' directory and copy it to the clipboard.
pwd | pbcopy

An example of the path is: /Users/name/downloads/referenceapplication-standalone-2.6.0/appdata\owa

Modify the path to look like: /Users/name/downloads/referenceapplication-standalone-2.6.0/appdata\\owa/

Copy the path.

# Open the webpack.config.js file, locate the getConfig function and update the config object with the following
{
  "LOCAL_OWA_FOLDER": "PASTE_THE_PATH_YOU_COPIED_HERE",
  "APP_ENTRY_POINT": "http://localhost:8081/openmrs-standalone/owa/openmrs-addonmanager/index.html"
}

Note: Start your cohort builder standalone server locally. Make sure you tomcat port is 8081, if not, change the APP_ENTRY_POINT localhost port to be the same as your tomcat port.

# Run the app
npm run watch

Production Build

You will need NodeJS 4+ installed to do this. See the install instructions here.

Once you have NodeJS installed, install the dependencies (first time only):

npm install

Build the distributable using Webpack as follows:

npm run build:prod

This will create a file called openmrs-addonmanager.zip file in the root directory, which can be uploaded to the OpenMRS Open Web Apps module.

Local Deploy

To deploy directly to your local Open Web Apps directory, run:

npm run build:deploy

This will build and deploy the app to the /Users/name/downloads/referenceapplication-standalone-2.6.0/appdata/owa directory. To change the deploy directory, edit the LOCAL_OWA_FOLDER entry in config.json. If this file does not exists, create one in the root directory that looks like:

{
  "LOCAL_OWA_FOLDER": "/home/sims01/openmrs/openmrs-server/owa/",
  "APP_ENTRY_POINT": "http://localhost:8081/openmrs/owa/openmrs-addonmanager/index.html"
}

Live Reload

To use BrowserSync to watch your files and reload the page, inject CSS or synchronize user actions across browser instances, you will need the APP_ENTRY_POINT entry in your config.json file:

{
  "LOCAL_OWA_FOLDER": "/home/sims01/openmrs/openmrs-server/owa/",
  "APP_ENTRY_POINT": "http://localhost:8081/openmrs/owa/openmrs-addonmanager/index.html"
}

Run Browsersync as follows:

npm run watch

Extending

Install npm packages dependencies as follows:

npm install --save <package>

To use the installed package, import it as follows:

//import and assign to variable
import variableName from 'package';

To contain package in vendor bundle, remember to add it to vendor entry point array, eg.:

entry: {
  app : `${__dirname}/app/js/owa.js`,
  css: `${__dirname}/app/css/owa.css`,
  vendor : [
    'package',
    ...//other packages in vendor bundle
  ]
},

Any files that you add manually must be added in the app directory.

Troubleshooting

HTTP access control (CORS)

You may experience problems due to the Access-Control-Allow-Origin header not being set by OpenMRS. To fix this you'll need to enable Cross-Origin Resource Sharing in Tomcat.

See instructions here for Tomcat 7 and here for Tomcat 6.

Releasing

In order to release, set a new version in package.json, bintray.json and app/manifest.webapp. Once you commit and push changes to github, go to https://github.com/openmrs/openmrs-owa-addonmanager/releases and create a new release named after the version you want to release. Travis CI should pick up a newly created tag and deploy the release to Bintray at https://bintray.com/openmrs/owa/openmrs-owa-addonmanager

License

MPL 2.0 w/ HD

You can’t perform that action at this time.