Skip to main content

Build Tutorial

Let's Build AIDE in less than 10 minutes.

Build Tools​

Notice that other versions may work, but we only test the project with these versions.

Build Server side​

Clone the repository:

git clone git@github.com:sustech-cs304/team-project-25spring-42.git

Go to the server directory:

cd team-project-25spring-42/server

Install the dependencies:

mvn clean install

Start the server:

mvn spring-boot:run

We also provide the Dockerfile and docker-compose.yml file to run the server in a docker container. You can run the following command to start the server:

Build the jar file:

mvn package

Run the image

docker-compose up -d

Build Client side​

Clone the repository:

git clone git@github.com:sustech-cs304/team-project-25spring-42.git

Go to the client directory:

cd team-project-25spring-42/client

Change the SERVER_URL and SERVER_URL_WS in utils/ServerConfig.java to your server address before you run the client. For example, if your server is running on localhost:8080, you need to change it to:

public static final String SERVER_URL = "http://localhost:8080";
public static final String SERVER_URL_WS = "ws://localhost:8080/ws/websocket";

Install the extra dependency to your local Maven repository:

mvn install:install-file \
  -Dfile=lib/Monacofx.jar \
  -DgroupId=eu.mihosoft.monacofx \
  -DartifactId=monacofx \
  -Dversion=1.0.0 \
  -Dpackaging=jar

To quick start the client:

mvn javafx:run

Or if you want to build a application:

For MacOS​

You should download the javafx SDK from Gluon and put it in the lib directory. Download the JavaFX SDK 23.0.1, you should put it in lib/javafx-sdk-23.0.1.

Then you can build the application by running:

mvn clean package

Then you can run the application by double clicking the AIDE.dmg file in the dist directory.

For Windows:​

You should download the javafx SDK from Gluon, choose following options:

  • JavaFX version: 23.0.1

  • Operating System: Windows

  • Architecture: x64

  • Type: SDK

Include archived versions and put it in the lib directory.

Then you can build the application by running:

mvn clean package

after that, you need to copy all of the files in folder lib\javafx-sdk-23.0.1\bin to the dist\AIDE\bin directory, and copy all of the files in lib\javafx-sdk-23.0.1\lib to the dist\AIDE\runtime\bin directory.

Then you can run the application by double clicking the AIDE.exe file in the dist\AIDE directory.