License Terms

This program is part of the OpenLMIS logistics management information system platform software. Copyright © 2013 VillageReach

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program.  If not, see http://www.gnu.org/licenses.  For additional information contact [email protected]. 

System Requirement

• JDK 7

• Postgresql 9

• Git

• Gradle 1.6

  For Linux users

  • Download the source binary directly from the gradle website. Copy the downloaded folder to /usr/bin.
  • Add the path to gradle bin folder to your /etc/profile file export PATH="$PATH:/usr/bin/gradle-1.6/bin"

  For Mac users

  • Install HomeBrew
  • Run brew install gradle

• Node.js

  For Linux users

  • Install Nodejs as described here based on your Linux flavour.

  For Mac users

  • Install Node.js directly or using homebrew using brew install nodejs
  • Those who install Node.js using Homebrew should export the following (or include in $HOME/.bash_profile or $HOME/.profile or $HOME/.bashrc or $HOME/.zshrc, depending on your shell.
    • export NODE_PATH="/usr/local/bin/node"
    • export PATH="/usr/local/share/npm/bin:$PATH"

• NPM dependencies (used for linting JS, LESS files, minifying JS files & running jasmine specs etc.)

  • Install Grunt command-line runner by running (after installing Node.js as mentioned in aformentioned step) npm install -g grunt-cli
  • Install project-specific grunt dependencies by navigating to modules/openlmis-web from project root directory and run npm install (one-time activity)
  • Install karma test runner with karma coverage by running npm install -g karma karma-coverage
  • Grunt tasks available can be found in modules/openlmis-web/Gruntfile.js

Source code

1. Get the source code using git clone http://github.com/OpenLMIS/open-lmis/
2. Also resolve dependencies on submodule using command git submodule init and then git submodule update

IntelliJ IDEA Setup

1. Run gradle idea to create the IntelliJ project files (may take some time downloading dependencies)
2. Open the open-lmis.ipr file (may take some time indexing files, first time only)
3. Install Lombok plugin according to the IntelliJ version.

Running App on embedded Jetty server

1. Clone the project repository using git.

2. Setup postgres user with password as configured in gradle.properties file.

3. You can use gradle clean setupdb seed build testseed run to start the app.

There are bunch of gradle tasks that you can see by running gradle tasks

• build is to build the app.
• setupdb is to recreate the database and schema.
• seed is to seed in the reference data.
• testseed puts in some test data which can be used to browse through basic functionality in the system.
• run is to start the embedded jetty server.

Once run, you can access the home page at http://localhost:9091/

Tech Stack

• Java 1.7
• Gradle
• Postgres
• Spring
• Mybatis
• Angularjs
• Jasmine
• Node.js
• Grunt.js