Eclipse

1) Download and install Eclipse IDE for Java EE Developers (2020‑12), e.g., from eclipse.org/downloads using the Eclipse Installer

2) Create UniTime project

If you plan to make changes, you should consider forking the UniTime project first. See Fork A Repo for more details.

a) If you already have a GIT project cloned somewhere, you can just import it:

    • File > Import, select Git > Project from Git, Next

    • Select "Existing local repository", click Next

    • Click Add, select the git directory, select the UniTime git project, click Finish

    • Select UniTime, click Next, click Next, click Finish

b) If you do not have a GIT project already cloned somewhere:

    • File > Import, select Git > Project from Git, Next

    • Select "Clone URI", click Next

    • Enter "https://github.com/UniTime/unitime.git" as URI, the rest should auto populate from the URL, click Next

      • Or, you can use "git@github.com:UniTime/unitime.git" as URI, and generate an SSH key (see Generating SSH keys for more details)

    • If you have forked the unitime repository, the URI will be different

    • Click Deselect All, select master and the maintenance branches you want/need (if any).

    • Click Next

3) Install GWT Eclipse Plugin

    • Help > Install New Software...

    • Click Add, Name: GWT Plugin for Eclipse, Location: http://storage.googleapis.com/gwt-eclipse-plugin/v3/release, OK

    • Select GWT Eclipse Plugin and GWT SDK

    • Click Next, Next, accept license terms and Finish

    • If there is a warning about installing software that contains unsigned content, click OK

    • Restart Eclipse after the install


    • Download GWT 2.8.2 from gwtproject.org/download.html and unzip it.

    • In Eclipse, open File > Properties, select GWT > GWT Settings, click Add

    • Select a directory that has an unzipped distribution of GWT 2.8.2, hit OK

    • Select gwt-2.8.2 as the default, click OK

  • Right click on the UniTime project, click Properties, select GWT > Web Application, toggle "This project has a WAR directory", click OK

4) Setup Apache Tomcat

This guide expects that you already have the Apache Tomcat downloaded and installed somewhere.

a) Setup JRE and its parameters

    • Open File > Properties, select Java > Installed JREs, click Edit

    • Put in the following Default VM arguments, hit Finish

-Xmx2g -XX:+UseConcMarkSweepGC -XX:MaxPermSize=128m

    • You can also include a path to the UniTime custom.properties file if needed

-Dtmtbl.custom.properties=/path/to/custom.properties

b) Create Apache Tomcat v.9.0 server configuration

    • Open File > Properties, select Server > Runtime Environments, click Add

    • Select Apache Tomcat v9.0, check the "Create a new local server", click Next

    • Select Tomcat installation directory, hit Finish

c) Compile GWT

  • Right click on the UniTime project, select GWT, click on Compile

  • Make sure that either UniTimeDev (fewer permutations) or UniTime (all permutation) but not both is on the Entry Point Modules list, click Compile

  • If asked, select WebContent as the WAR directory

d) Deploy UniTime

    • Right click on the UniTime project, click Properties, select Project Facets, toggle Dynamic Web Module, Java, and Java Script, click OK

    • Right click on the UniTime project, select Run As, click on Run on Server

      • If asked, select Tomcat v9.0 Server, click Finish