Overview

The web-version is the currently supported one of this tool. It provides a web-ui, that can be accessed through your browser. The user therefore does not need to install anything new on their machine, and can just connect to a server. The only disadvantage of this version is, that the setup is not as automated as the setup for the standalone-client.

Setup

Before running the application, you need to have a database ready, where the web-server can connect to.

Create .war-file

To run the application, you need the .war-file of it. If you don't have a version of it, or want to use a modified version of the tool, you can build the .war-file yourself.

1. Update the application.properties-file before you build the .war-file, so that the properties match the ones your database has. This can be very useful, if you don't want to put a custom application.properties-file next to your .war-file when you run it.
2. If you want to, update or change the code before building.
3. Use mvn clean install to generate the .war-file.

If you have already built the .war-file, but need to adjust some properties to work with your database, you can create an external application.properties-file.

Create docker-image

If you want to run the application within a docker-container, you can create a docker-image with docker build --tag=language-generator:latest .. Make sure, that you generated the .war-file before this command.

Run the application

Before you can run the web-server, you need to make sure, that the database is running.

Run .war-file

To run the .war-file, you need to execute it with java -jar WAR_FILE.war. If you want to change some settings from the application.properties-file, you don't need to re-build the .war-file, but can instead add an external application.properties-file, like mentioned here.

Run docker-image

If you have created a docker-image of the application, you can run it with docker run -p8573:2345 language-generator:latest.

Connect to the website

Once the web-server is successfully started, you can connect to it via your browser. With the default settings it should be reachable under http://localhost:2345/