Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/kwame-mintah/javafx-spring-boot-loan-application

An application that allows users to loan out items, from books to a toys and the ability to manage the items out on loan.
https://github.com/kwame-mintah/javafx-spring-boot-loan-application

docker-compose javafx javafx-application spring-boot springframework

Last synced: about 1 month ago
JSON representation

An application that allows users to loan out items, from books to a toys and the ability to manage the items out on loan.

Awesome Lists containing this project

README 

        
## JavaFX Springboot Loan Application



## Description



This project is an example of using JavaFX and Spring-boot together. Originally created for my university module assignment

and has been made public to help others who would like to use both JavaFX and Spring-boot. This repository will not receive 

any code changes and will be left in the same state that it was submitted. The application allows users to loan out items, 

from books to a toys and can manage the items they have loaned out.



## Development



### Prerequisites



The application uses the following software and frameworks:



* [JavaFX 18](https://openjfx.io/)

* [Java 11](https://openjdk.java.net/projects/jdk/11/)

* [Scene builder](https://gluonhq.com/products/scene-builder/)

* [Docker for desktop](https://www.docker.com/products/docker-desktop/)

* [Postgres 14](https://www.postgresql.org/about/news/postgresql-14-released-2318/)

* [Spring Boot](https://spring.io/)

* [Maven 3.8.5](https://maven.apache.org/download.cgi?Preferred=ftp://ftp.osuosl.org/pub/apache/)



If you would like to continue developing this application on your local machine, please ensure you have the above installed

and configured.



### Usage



In order to run the application locally, you will first need to have the database running:



1. Navigate to the directory that 'javafx-springboot-loan-application' is stored,

2. Type `docker-compose -up -d` in the root directory to start the postgres container.



This should start up the database and populate the 'library-system-db' with initial data for local usage.



After the database has been started, you can then start the application, for IntelliJ users you can perform the 

following:



1. Right-click the 'LibrarySystemApplication' and click on 'Run LibrarySystemApplication...main()',

2. The first attempt may fail due to: `Error: JavaFX runtime components are missing, and are required to run this application`

3. Right click and Edit the 'LibrarySystemApplication' configuration in IntelliJ and add the following VM options:

   ```

   --module-path /your/path/to/javafx-sdk-18/lib --add-modules=javafx.controls,javafx.fxml

    ```

4. Run the 'LibrarySystemApplication' configuration again via IntelliJ.



**Note**: You can use the following user to access the application: `ben.tennyson`, the other user `dexter.lab` is disabled

and will not be able to access the application.



| Username     | Password   | Role          | Enabled |

|--------------|------------|---------------|---------|

| ben.tennyson | Pa55Word1! | standard      | true    |

| dexter.lab   | Pa55Word1! | administrator | false   |



## Troubleshooting



__Application throws JDBCConnectionException / PSQLException on start-up?__



Ensure that the database is up and running, the application will attempt to connect to hostname: localhost on port: 5432.

Using the username: postgres and password: password on the 'library-system-db' database. If you're running on a different 

port or the user 'postgres' does not exist. Please update the `application.properties` to reflect any of these changes.

You can either use environment variables to change the values or update the file itself.



__Unable to start application due to: 'JavaFX runtime components are missing ...'__



If you get this error, double check you have provided the correct path to your [javafx-sdk](https://gluonhq.com/products/javafx/) files

in your VM arguments for 'LibrarySystemApplication' configuration in IntelliJ.