Development Environment Setup Windows

Required Software

Note: Since we currently don't have a developer with a Windows machine, this guide is not fully updated and untested. Please refer to Development Environment Setup, which describes the set up for Linux/MacOS and let us know if you find any issues with this page!

Install Java JDK 8

• Download from http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html and install.
• Determine the Java home directory path (under Windows it is usually similar to C:\Program Files\Java\jdk1.8.0_67).
• Add JAVA_HOME to the environment variables with the value: C:\Program Files\Java\jdk1.8.0_67.
• Update/create Path environment variable: prepend the value %JAVA_HOME%\bin to make Java available in the command line.
• Open a new command prompt (Winkey + R then type cmd) and run java -version to verify that it is correctly installed.

Install MySQL server

• Download from dev.mysql.com/downloads/mysql/ and install.
• Open a new command prompt (Winkey + R then type cmd) and run mysql -u root -p, type in the password set during installation and verify that it is correctly installed.

Setup for Development

0. Clone the XCoLab GitHub repository: https://github.com/CCI-MIT/XCoLab. Lets call the directory to which the repository was downloaded SRC.

1. Copy file SRC/conf/application.properties to ~/.xcolab.application.properties and edit it to match your local configuration for mysql

2. Create a database that uses "utf8mb4 collation" encoding and specify a user & password:

   mysql -u root -p 
   CREATE DATABASE xcolab
       CHARACTER SET utf8mb4
       COLLATE utf8mb4_unicode_ci;

3. Compile the sources to create the database schema. From the root directory, run:

   ./mvnw.cmd compile
   

4. Populate the database with initial data. You can use our database starter to get started with a new XCoLab instance:

   mysql -u xcolab_user -p xcolab < SRC/db/starter/xcolab-data.sql
   

   Note: if you see errors about the date format, go to control panel -> region & language -> change to a U.S. type format.

5. Make sure you are in the root directory of the repository: (cd XCOLAB_SRC)

6. Build the whole project by running ./mvnw.cmd package (this downloads all dependencies, which may take a few minutes the first time).

7. Start the servers. You can start them from your IDE (IntelliJ IDEA Ultimate's run dashboard lets you start all servers at once). There's also a bash script to start all servers from the jars (./startAll.sh). Unfortunately, we don't have a windows version at this time - let us know if you want to contribute one! Starting may take a few minutes, it will be much faster when you only restart some servers.

8. Once all servers are started, you can access the site here: http://localhost:18082/