RC2 Desktop Modules

About

• This is an open source project developed for humanitarian responses
• Consult the user manual for further details

Dependencies

Maven 3.6 or higher

• Can be downloaded from Apache
• MAVEN_HOME variable should be set to the pathing for the main directory as an environmental variable
  • E.g. C:\Program Files\Maven\apache-maven-3.8.4 (make adjustments for version and location)
• M2 variable should be set to the pathing for the bin folder as an environmental variable
  • I.e. %MAVEN_HOME%\bin (Windows), $MAVEN_HOME/bin (Linux, Mac)

Java 1.8 JDK

• Older versions of Java can be downloaded from Oracle (requires an Oracle account)
• JAVA_HOME variable should be set to the pathing for jdk-1.8 as an environmental variable
  • E.g. C:\Program Files\Java\jdk-1.8 (make adjustments for location)
• Once install is complete, it may also be necessary to ensure that the editor being used is also set utilize 1.8

Setting Environmental Variables

Windows

• Control Panel > System and Security > System > Advanced System Settings > Environment Variables > (under System Variables) New
  

  ---

  OR search system environment variables in Search Bar > select Edit the system environment variables > Environment Variables > (under System Variables) New

  ---

  • Set Variable name to [respective name]
  • Set Variable value to [respective path]

Linux/Mac

• Open Terminal

export M2_HOME=<respective path>
export M2=$M2_HOME/bin
export JAVA_HOME=<respective path>

Clone the repo

cd <directory you want to download into>
git clone --recurse-submodules https://github.com/RC2-Tools/RC2-desktop.git

#After creating a fork into your own repository
git clone --recurse-submodules https://github.com/<YourUserName>/RC2-desktop.git

• git can be downloaded from git-scm
• After logging into or making an account on GitHub, use button on upper right to make a Fork before doing second step

Build

• Run mvn clean install
• To make the installer, run mvn clean deploy

Optional

• Use -DskipTests to skip tests
• Use -Dapp-designer.directory=PATH to use PATH instead of the app-designer submodule

Build HTML for Tables

• In app-designer, run grunt compile-config-templates
  • grunt can be downloaded from gruntjs
    • Requires npm which is an extension of nvm
      • For Windows, install nvm-windows
      • For Linux/Mac install nvm
      • Once nvm is installed, it may be necessary to turn nvm on in the command line before npm is recognized