robbyoconnor / openmrs-contrib-modulus-ui

Web app & user interface for Modulus

Modulus UI

=====

This is the web-based interface of Modulus, the OpenMRS Modules directory. It's a static, single-page web application written in AngularJS and provides a frontend to Modulus's REST API.

Building

(for an in-depth guide on setting up a Modulus server with Modulus UI on the frontend, check out the guide on the OpenMRS Wiki)

1. You need Node v0.8 or greater installed.

2. Clone the source code:

    $ git clone https://github.com/openmrs/openmrs-contrib-modulus-ui.git
    $ cd openmrs-contrib-modulus-ui
   

3. Install all dependencies:

    $ npm install
   
    # If you don't already have grunt installed on your system:
    $ npm install -g grunt-cli
   

4. Check configuration settings in config/modulusui.conf.js. Most importantly, you'll want to check these settings:

   • api.baseUrl, the URL of the Modulus server that Modulus UI will connect to
   • appUrl, the URL Modulus UI will be served from
   • auth.authenticateUrl and auth.clientId, parameters used to perform OAuth login with OpenMRS ID

5. Build & run:

    # To build a static copy of Modulus UI in ./app:
    $ grunt build
    
    # To run a development server:
    $ grunt serve
   

---

Contribute

We'd love it if you'd like to give ideas, code contributions, or criticisms.

Most feedback and development coordination is on the MOD JIRA Project.

Continous deployment is managed on OpenMRS CI. master auto-deploys to https://modules-stg.openmrs.org and prod auto-deploys to https://modules.openmrs.org