How to run it (Operator Guide) - iks-gmbh-tools/Fileman GitHub Wiki

Hint: This is mainly a shorter version of the Developer Guide. The Operator Guide focuses on what needs to be done to run the Fileman application, while the Developer Guide also includes everything you need to know when taking part in development (e.g. setting up an IDE).

Check out the source code from this repository. (As we are on GitHub here, we assume that you are already familiar with Git and know how to set it up. If not, see e.g. here.)

What you need to run the Fileman application:

1) Frontend - Setup

a) Install Node.js (as you need its package manager Node Package Manager, shortly called npm). Download it here.

b) Install the Angular CLI by executing the command npm install -g @angular/cli on the system command line.

c) Navigate into the "Fileman-Frontend" subdirectory under your chosen Git checkout path and run the command npm install. This will download all necessary dependencies into a subfolder "node_modules". (This is large and therefore not contained in the Fileman GitHub repository.)

2) Frontend - Running the application

a) Navigate into the "Fileman-Frontend" subdirectory under your chosen Git checkout path and run the command ng serve. This will make the Fileman frontend available under "http://localhost:4200/fileman".

3) Backend - Setup

a) Install Java. If you only want to run the application, it is enough to download the JRE (the JDK is only needed if you also want to take part in development). The minimum version needed to work with the backend is Java 8. However, we recommend using Java 10 or higher. You can download Java here. After the installation, check whether the "JAVA_HOME" enviroment variable has been created in your system (and create it if necessary), pointing to the JRE installation directory (e.g. "C:\Program Files\Java\jre-10.0.2"). Also check whether the entry "%JAVA_HOME%\bin" is existing in your "Path" variable (and add it if necessary).

b) Install the build tool Maven. Download Maven here. After the installation, you need to add the "MVN_HOME" environment variable to your system, pointing to the Maven main directory (e.g. "C:\dev\apache-maven-3.6.3"). Also make sure to add the entry "%MVN_HOME%\bin" to your "Path" variable.

c) To initially build the Fileman backend, you need to navigate into the "Fileman-Backend" subdirectory under your chosen Git checkout path and run the Maven command mvn clean install.

d) The first time you start the application, uncomment the line spring.datasource.data = classpath:/insertDefaultData.sql" in the file Fileman-Backend/src/main/resources/application.properties, so that the H2 database will be created with its initial contents.

e) After you have started the application for the first time (see section below), comment the line spring.datasource.data = classpath:/insertDefaultData.sql" in the file Fileman-Backend/src/main/resources/application.properties again, in order to avoid a failure when starting the backend a second time.

4) Backend - Running the application

a) Navigate into the "Fileman-Backend" subdirectory under your chosen Git checkout path and run the Maven command mvn spring-boot:run. The backend is then available under "http://localhost:10002/fileman/".