OpenBoxes is an Open Source Inventory and Supply Chain Management System. The initial implementation of OpenBoxes will occur at Partners In Health-supported facilities in Haiti.

Copyright (c) 2012 Partners In Health. All rights reserved. The use and distribution terms for this software are covered by the Eclipse Public License 1.0 (http://opensource.org/licenses/eclipse-1.0.php) which can be found in the file epl-v10.html at the root of this distribution. By using this software in any fashion, you are agreeing to be bound by the terms of this license. You must not remove this notice, or any other, from this software.

####Dependencies

• Eclipse IDE for Java EE Developers
• Java 1.6
• Grails 1.3.7
• MySQL 5+
• Tomcat 6 or 7 (optional for dev envrionment)

####Setup Instructions

• Install dependencies above

• Download/install Grails 1.3.7

• Add grails to your PATH variable

• If you are a not core contributor, fork openboxes git repository

• If you are a core contributor:

    git clone git@github.com:PIH/openboxes.git      
  

  otherwise, replace git url with the one of your forked repository

• Create openboxes database for dev and test environments

    mysql -u root -p -e 'create database openboxes_dev default charset utf8;'
    
    mysql -u root -p -e 'create database openboxes_test default charset utf8;'       
  

• Create openboxes user for databases

    mysql -u root -p -e 'grant all on openboxes_dev.* to openboxes@localhost identified by "openboxes";'
  
    mysql -u root -p -e 'grant all on openboxes_test.* to openboxes@localhost identified by "openboxes";'      
  

• Create new openboxes-config.properties file under $HOME/.grails (not sure if the quickCategories will work as the default system categories might be different from ours)

    # Database connection settings
    # You can use dataSource.url when you are using a non-dev/non-test database (test-app may not run properly)
    #dataSource.url=jdbc:mysql://localhost:3306/openboxes?autoReconnect=true&zeroDateTimeBehavior=convertToNull&sessionVariables=storage_engine=InnoDB
    dataSource.username=openboxes
    dataSource.password=openboxes
  
    # OpenBoxes mail settings - disabled by default
    grails.mail.enabled=false
  
    # Application settings
    #inventoryBrowser.quickCategories=ARVs,MEDICAL SUPPLIES,FOOD,EQUIPMENT,MEDICINE
    #openboxes.loginLocation.requiredActivities = ["MANAGE_INVENTORY"]
  
    # Google Product Search
    #google.api.key=<Google API key>
  
    # Hipaaspace.com API (NDC Lookup)
    #hipaaspace.api.key=<hipaaspace API key>
  
    # RXNorm API
    #rxnorm.api.key=<RxNorm API key>
  
    # Google analytics
    #google.analytics.enabled = false
    #google.analytics.webPropertyID = <Google Analytics Key>
  

• Upgrade grails version and plugins for grails

     grails upgrade
  

• Start application in development mode (you may need to run 'grails run-app' several times in order to download all dependencies).

     grails run-app
  

• Open Chrome

• Navigate to http://localhost:8080/openboxes

• Login with username/password (manager:password OR admin:password)