Anpassungen an get_started.txt, howtoBuild.adoc
diff --git a/get_started.txt b/get_started.txt
index 389bd68..6eac812 100644
--- a/get_started.txt
+++ b/get_started.txt
@@ -1,12 +1,16 @@
-******************************************************************************
-* Copyright © 2018 PTA GmbH.
-* All rights reserved. This program and the accompanying materials
-* are made available under the terms of the Eclipse Public License v1.0
-* which accompanies this distribution, and is available at
-*
-* http://www.eclipse.org/legal/epl-v10.html
-*
-******************************************************************************
+ *******************************************************************************
+ * Copyright (c) 2020 Contributors to the Eclipse Foundation
+ *
+ * See the NOTICE file(s) distributed with this work for additional
+ * information regarding copyright ownership.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v. 2.0 which is available at
+ * http://www.eclipse.org/legal/epl-2.0.
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *******************************************************************************
+
>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
GET STARTED
>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
@@ -21,7 +25,7 @@
---------------- REQUIREMENTS -------------
* Java 1.8
* Apache Maven 3.6.1
-* Graphviz
+
IF you have this versions, check if you have set JAVA_HOME and M2_HOME.
- If yes: Ignore step 1 and 2
@@ -70,10 +74,10 @@
Value of variable: <GRAPHVIZ_DIR>\bin
-------------------- 4 ---------------------
-To get started with the project you have to clone contactBaseData backend and frontend projects.
+To get started with the project you have to clone gridFailureInformation backend and frontend projects.
-Backend <project_url>: https://git.eclipse.org/r/openk-coremodules/org.eclipse.openk-coremodules.contactBaseData.backend
-Frontend <project_url>: https://git.eclipse.org/r/openk-coremodules/org.eclipse.openk-coremodules.contactBaseData.frontend
+Backend <project_url>: https://git.eclipse.org/r/openk-usermodules/org.eclipse.openk-usermodules.gridFailureInformation.backend.git
+Frontend <project_url>: https://git.eclipse.org/r/openk-usermodules/org.eclipse.openk-usermodules.gridFailureInformation.frontend.git
- Create a folder and do following for each of them
- Open a cmd and navigate to the folder
@@ -100,7 +104,15 @@
-------------------- 5 ---------------------
Build the maven project
-Building the maven project, will produce a <project_name>.jar file, which is needed to run the project.
+The backend repository consists of several subprojects. The main backend is the
+"gfsBackService". Depending on the interfaces and the features you want to use, you
+need to build other subprojects as well:
+-addressImport: Importing addresses from csv-files
+-mailExport: Publish messages via e-mail
+-stoerungsauskundtInteraces: Export and import messages from the site "stoerungsauskunft.de"
+-others in future
+
+Building such a maven project, will produce a <project_name>.jar file, which is needed to run the project.
- Open a command line and navigate to the root folder of the backend project
- Use the following call to cleanly build and install artifacts into the local repository:
$ mvn clean install
diff --git a/src/main/asciidoc/howto/howtoBuild.adoc b/src/main/asciidoc/howto/howtoBuild.adoc
index fe5adb8..688050c 100644
--- a/src/main/asciidoc/howto/howtoBuild.adoc
+++ b/src/main/asciidoc/howto/howtoBuild.adoc
@@ -1,4 +1,4 @@
-= openKonsequenz - How to build the module "eLogbook@openK"
+= openKonsequenz - How to build the module "grid-failure-information@openK"
:Date: 2017-11-17
:Revision: 1
:icons:
@@ -7,59 +7,25 @@
<<<
-IMPORTANT: Please be sure that you have first *Portal (Auth n Auth)* installed and configured!
+IMPORTANT: Please be sure that you have first *Portal (Auth n Auth)* and *ContactBaseData* installed and configured!
== Requirements
-* Apache Tomcat 8.0.30
-* Node.js 6.10.0
+* Node.js 12.14.0
* Angular-CLI
-* Graphviz
== How to build the Backend
To build the backend you need to have installed Apache Maven and Java (look at `/deploy/`*get_started.txt*).
-=== Install and Configure Apache Tomcat
-Tomcat is an open-source Java Servlet Container and provides a "pure Java" HTTP web server environment in which Java code can run.
-
-* Download Tomcat version 8.0.30 from https://archive.apache.org/dist/tomcat/tomcat-8/v8.0.30/bin/
-and extract it (apache-tomcat-8-0-30.zip).
-* Place the extracted folder on your C drive.
-* Configure Tomcat:
-** Configure the *context.xml* file. Copy the *<Resource … >* block from the project file `deploy/conf/`*context.xml*
-and paste it in the `<tomcat>/conf/`*context.xml* in the *<Context>* block.
-** To run both backend projects (elogbook and portal) at the same time on Tomcat you have to
- give him the parameters for different backend configs. Just paste the following line in the *context.xml* over the *<Resource … >*:
-
- <Parameter name="OK_ELOGBOOK_ENVIRONMENT" override="false" value="DevLocal"/>
-
-** Dont forget to save it.
-
-
-TIP: For more informations check *Deployment View* Chapter in *http://87.128.212.254:8880/elogbookFE_ADoc/elogbook_architectureDocumentation.html[elogbook_architectureDocumentation]*.
-
-** Tomcat also needs the database driver to be placed in `<tomcat>/lib`. Find it in the project file `deploy/lib/`*postgresql-xxx.jar*.
-
-
-=== Install Graphviz
-Graphviz is open source graph visualization software. You need this software because of auto-generated graphics in the documentations.
-
-* Download and install Graphviz from http://www.graphviz.org/Download_windows.php
-* If not, set the PATH variable
-
- Name of variable: GRAPHVIZ_DOT
- Value of variable: <GRAPHVIZ_DIR>\bin\dot.exe
-
-
== How to build the Frontend
=== Install Node.js
Node.js is an open-source, cross-platform JavaScript run-time environment for executing JavaScript (also Typescript which is a strongly typed form of JavaScript) code server-side.
-* Download Node.js 6.10.0 from https://nodejs.org/download/release/v6.10.0/ by clicking on a xxx.msi image for windows.
+* Download Node.js 12.14.0 from https://nodejs.org/download/release/v12.14.0/ by clicking on a xxx.msi image for windows.
* Run the downloaded Node.js .msi Installer - including accepting the license, selecting the destination, and authenticating for the install.
This requires Administrator privileges, and you may need to authenticate
-* To ensure Node.js has been installed, run the following in your terminal - you should get something like v6.10.0
+* To ensure Node.js has been installed, run the following in your terminal - you should get something like 12.14.0
[source,command]
----
@@ -85,7 +51,7 @@
----
{blank}
-TIP: Next Step -> Read the *elogbook_howtoRun* file!
+TIP: Next Step -> Read the *grid-failure-information_howtoRun* file!
diff --git a/src/main/asciidoc/howto/howtoRun.adoc b/src/main/asciidoc/howto/howtoRun.adoc
index 66e895e..6204fd4 100644
--- a/src/main/asciidoc/howto/howtoRun.adoc
+++ b/src/main/asciidoc/howto/howtoRun.adoc
@@ -1,4 +1,4 @@
-= openKonsequenz - How to run the module "eLogbook@openK"
+= openKonsequenz - How to run the module "gridFailureInformation@openK"
:Date: 2017-11-17
:Revision: 1
:icons:
@@ -7,33 +7,36 @@
<<<
-IMPORTANT: Please be sure that you have first *Portal (Auth n Auth)* installed and configured!
+IMPORTANT: Please be sure that you have first *Portal (Auth n Auth)* and *ContactBaseData* installed and configured!
== Requirements
-* Browser (Chrome or IE11 suggested)
+* Browser (Chrome or Edge suggested)
== Prerequisites
-* *To see this application running you have to run Portal application too.* The reason is the authentication, which happened in the Portal login phase.
+* *To see this application running you have to run Portal and ContactBaseData application too.*
+The reason is the authentication, which happened in the Portal login phase. Additionally
+contacts that are used in the gridFailureInformation application are maintained in the
+ContactBaseData module.
* A developing and administrating software for databases
** To work with a postgreSQL database is pgAdmin suggested
-*** Download and install pgAdmin (version 3 is used during developing process) from:
+*** Download and install pgAdmin (version 4 is used during developing process) from:
https://www.pgadmin.org/download/
-*** Create a database and adapt the `<tomcat>/conf/`*context.xml* file to your database (look at *elogbook_howtoBuild*).
-*** To initialize the database schema run the sql scripts:
+*** Create a database
- /db/postgreSQL/02_create_DB_1.0.0.sql
- /db/postgreSQL/03_config_DB_1.0.0.sql
+*** To initialize the database schema run the latest sql script:
+ /src/resources/db/migration/V0_??__CREATE_GFI_DB.sql
-TIP: For detailed instructions look at *http://87.128.212.254:8880/elogbookFE_ADoc/elogbook_architectureDocumentation.html[elogbook_architectureDocumentation]*
== How to run the Backend
-To run the backend you need to have installed and configured Apache Tomcat (look at *elogbook_howtoBuild*).
+To run the backend you to create a separate directory for each backend microservice
+you want to use, get the **.jar* file from the *target* directory of the java-project (which should exists after
+a successful maven-build) and copy it to the new directory (i.e. "gfsBackService"). Y
=== Set up and start Apache Tomcat
Tomcat needs the Web Application Archive (war) file, which is produced by building the maven project, to run the application.
