GeRuMap

gerumap-tim_andrejanesic_aleksavucinic created by GitHub Classroom

Mind map application created in Java (Swing) as part of the Software Design (3307) pair assignment.

The project was conducted with the goal of practising:

• Software architecture / requirement modelling
• Design patterns & OOP
• Collaborative programming (Git)
• Client communication, documentation and more

1. Requirements & Documentation

The project has been documented using and may be accessed on the links below:

1. Requirements (client request): https://gerumap.notion.site/GeRuMap-Requirements-5484f5c082414cefa93308e405f314be

2. Documentation: https://andrejanesic.github.io/GeRuMap-Desktop-Mind-Mapper/

2. Authors

Authored by:

Aleksa Vucinic RN60/20 | Comp Sci Undergrad
School of Computing, Belgrade
[email protected]

Andreja Nesic RN31/19 | Comp Sci Undergrad
School of Computing, Belgrade
[email protected]
[email protected]

Mentored by:

dr. Ana Markovic | Professor at School of Computing, Belgrade
Academic achievements & biography
[email protected]

3. Build

It's possible to build this code via 2 methods:

3.1. Docker (Recommended)

The Docker-based build provides a tested, working environment where you'll be able to execute the code.

The provided Dockerfile sets up a Linux distro with the necessary libraries for displaying the app GUI.

Firstly, build the Dockerfile:

docker build -t gerumap .

Next, you'll need a server/relay tool to be able to visualize the app GUI on your local machine (such as socat for Linux or VcXsrv for Windows.)

Socat example for Linux:

# Run socat listener
socat TCP-LISTEN:6000,reuseaddr,fork UNIX-CLIENT:\"$DISPLAY\"

# Run image
docker run -v /tmp/.X11-unix:/tmp/.X11-unix -e DISPLAY=$(ipconfig getifaddr en0):0 gerumap

VcXsrv example for Windows:

# Make sure VcXsrv is running
# ...

# Run image
docker run -it --rm -d -e DISPLAY={Your IP address}:0 gerumap

3.2. Local

Running this code locally is not recommended due to possible issues caused by your Java installation and JVM parameters.

To build the code locally, run Maven on your local machine and execute the code:

# Build code
mvn clean install

# Execute main
mvn exec:java -Dexec.mainClass="rs.edu.raf.dsw.rudok.app.AppCore"