ghost-recon131/iit-a3-admin_management_software-artifact

Additional code for IIT A3

IIT - Monday Group 3 (Admin Management Software Artifact)

Main repository: https://github.com/Ghost-Recon131/IIT-A3

Admin Software (JavaFx + SpringBoot)

Running the .jar executable

• Likely requires Java JDK 1.8 from Oracle or any other JDK version that has JavaFx built in
• May need to run via terminal if you have newer version of Java JDK as default or if double-clicking doesn't work
• When launching via double-click, wait upward of 30-45seconds for software to start. It does not give any indication it is running unless you start via terminal or watch Task Manager for CPU usage.

java -jar admin-software-0.0.1-SNAPSHOT.jar

• Internet connection required as this program connects to an AWS RDS instance

Existing credentials

You can use the following account to login, or use Register to create a new account.

Accounts	Username	Password	Secret Question	Secret Question Answer
1	[email protected]	password	What is the name of this framework?	springboot

Program Behaviour

• When viewing logs, and you mark all of them as false positive, 4 new ones show up with the same details. This is expected behaviour as the code will populate the notifications tab with dummy data once there are no more entries in the database table.
• When exporting the logs, it will only export in the same directory as the .jar executable

Known Issues

• Fail to run if your internet connection cannot connect to RDS instance (no offline access)
• Home button icon / notification icon does not function unless you click them a few times. Unknown why this happens as no errors or exceptions show up during testing.

Manual Compilation

Prepare for manual compilation

• It is not possible to compile this program with connection to RDS backend as it uses credentials stored in "application-production.properties" file which is not pushed to GitHub to protect the login credentials. The file can be provided over email / MS Teams.
• To run without RDS instance, you edit the "application.properties" file and change it to the following:

# SpringBoot port config
server.port=9090

# Use dev profile
spring.profiles.active=dev

# Use production profile
#spring.profiles.active=production

• Then, set up a local MySQL database called 'IIT', and credentials of username "root and password "root "
• To use another name and or credentials, change the application-dev.properties file:

# Change from the original:
spring.datasource.url = jdbc:mysql://localhost:3306/IIT
spring.datasource.username=root
spring.datasource.password=root

# Modify the following: 
spring.datasource.url = spring.datasource.url = jdbc:mysql://localhost:3306/<Name of your database>
spring.datasource.username=<your database username>
spring.datasource.password=<your database username>

Compilation process (IntelliJ)

• Open the project in IntelliJ, on the right-hand side vertical menu, open Maven
• Expand the dropdown, then expand the Lifecycle dropdown again, then double-click on Package.

Compilation process (terminal)

• Check that maven is installed and added to path. If it is then the following command will display your maven version in the terminal.

mvn --version

• For some reason, the test class will stop manual compilation when compiling in terminal but not via IntelliJ
• To compile via terminal you will need to modify the AdminSoftwareApplicationTests.java file and comment out the test:

package rmit.iit.a3;

import org.junit.jupiter.api.Test;
import org.springframework.boot.test.context.SpringBootTest;

@SpringBootTest
class AdminSoftwareApplicationTests {

//	@Test
//	void contextLoads() {
//	}

}

• Then, in the same directory of the pom.xml file, run the following command:

./mvnw package

• After you see the build success message, go to the /target directory to get the compiled package.