From c9c024e4da8ed03281b98730d5dc657c31c280cd Mon Sep 17 00:00:00 2001 From: Martijn Dirkse Date: Fri, 2 Feb 2024 15:35:51 +0100 Subject: [PATCH 1/3] Explain what f-r does for Maven projects --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 56a63a7..21b2c96 100644 --- a/README.md +++ b/README.md @@ -670,6 +670,14 @@ edit the web application files in src/main/webapp and see the changes in your browser without the need to restart your Frank!. A small example can be found in [Frank2Example4](#frank2example4). +When you are developing a Maven webapplication with the Frank!Framework as dependency, you probably want to access it through http instead of https during development. The Frank!Framework only permits this if `dtap.stage=LOC`. + +When you write a webapplication with Maven, your `pom.xml` file defines how the application should be packaged. When you run your Maven project with the Frank!Runner during development, the following applies: + +* There is no need to add database drivers like h2 to `pom.xml`. The Frank!Runner installs them automatically. +* There is no need to add depencency `geronimo-jms_1.1_spec` to `pom.xml`. The Frank!Runner deploys it automatically. +* There is no need to configure a scenarios root directory for Larva. The Frank!Runner automatically configures the absolute path to `src/test/testtool`. +* There is no need to add properties `log.dir`, `log.level` and `dtap.stage` to `pom.xml`. These properties are set automatically by the Frank!Runner. # Root CA certificates From e9acb65ea1d789d8111b12f98c43cc6e1687f784 Mon Sep 17 00:00:00 2001 From: Martijn Dirkse Date: Fri, 2 Feb 2024 16:24:26 +0100 Subject: [PATCH 2/3] Modify the text because of Jaco-s review --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 21b2c96..57f4f43 100644 --- a/README.md +++ b/README.md @@ -672,12 +672,12 @@ in [Frank2Example4](#frank2example4). When you are developing a Maven webapplication with the Frank!Framework as dependency, you probably want to access it through http instead of https during development. The Frank!Framework only permits this if `dtap.stage=LOC`. -When you write a webapplication with Maven, your `pom.xml` file defines how the application should be packaged. When you run your Maven project with the Frank!Runner during development, the following applies: +When you write a webapplication with Maven, your `pom.xml` file defines how the application should be packaged. The Maven build is then typically what you need for production. During local development, the Frank!Runner helps you to deploy your application in Tomcat. The Frank!Runner then configures the following in Tomcat, allowing you to omit it from your `pom.xml`: -* There is no need to add database drivers like h2 to `pom.xml`. The Frank!Runner installs them automatically. -* There is no need to add depencency `geronimo-jms_1.1_spec` to `pom.xml`. The Frank!Runner deploys it automatically. -* There is no need to configure a scenarios root directory for Larva. The Frank!Runner automatically configures the absolute path to `src/test/testtool`. -* There is no need to add properties `log.dir`, `log.level` and `dtap.stage` to `pom.xml`. These properties are set automatically by the Frank!Runner. +* The Frank!Runner adds a database driver for the h2 database in Tomcat's `lib` folder. The Frank!Runner also adds a `context.xml` to allow access to a h2 database. +* The Frank!Runner adds `geronimo-jms_1.1_spec.jar` to Tomcat's `lib` folder. This file should not be packaged in your WAR because it should be provided by application servers according to the Jakarta EE standard. Tomcat does not provide this file however and hence this library has to be added. +* The Frank!Runner configures `catalina.properties` to define a scenarios root directory for Larva. The Frank!Runner configures the absolute path to `src/test/testtool`. +* The Frank!Runner configures in `cataline.properties` that `dtap.stage=LOC`. This way, you can access your webapp through http during development. If you do not set `dtap.stage` in your packaged application, it is up to the system administrator of the user to configure `dtap.stage`. # Root CA certificates From 2f218d5445be6a563ce73aadcc9fb9b8c3e3b1d6 Mon Sep 17 00:00:00 2001 From: Martijn Dirkse Date: Mon, 5 Feb 2024 10:18:04 +0100 Subject: [PATCH 3/3] Apply Jaco-s review comments --- README.md | 28 ++++++++++++++++++++-------- 1 file changed, 20 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 57f4f43..785b7d1 100644 --- a/README.md +++ b/README.md @@ -670,14 +670,26 @@ edit the web application files in src/main/webapp and see the changes in your browser without the need to restart your Frank!. A small example can be found in [Frank2Example4](#frank2example4). -When you are developing a Maven webapplication with the Frank!Framework as dependency, you probably want to access it through http instead of https during development. The Frank!Framework only permits this if `dtap.stage=LOC`. - -When you write a webapplication with Maven, your `pom.xml` file defines how the application should be packaged. The Maven build is then typically what you need for production. During local development, the Frank!Runner helps you to deploy your application in Tomcat. The Frank!Runner then configures the following in Tomcat, allowing you to omit it from your `pom.xml`: - -* The Frank!Runner adds a database driver for the h2 database in Tomcat's `lib` folder. The Frank!Runner also adds a `context.xml` to allow access to a h2 database. -* The Frank!Runner adds `geronimo-jms_1.1_spec.jar` to Tomcat's `lib` folder. This file should not be packaged in your WAR because it should be provided by application servers according to the Jakarta EE standard. Tomcat does not provide this file however and hence this library has to be added. -* The Frank!Runner configures `catalina.properties` to define a scenarios root directory for Larva. The Frank!Runner configures the absolute path to `src/test/testtool`. -* The Frank!Runner configures in `cataline.properties` that `dtap.stage=LOC`. This way, you can access your webapp through http during development. If you do not set `dtap.stage` in your packaged application, it is up to the system administrator of the user to configure `dtap.stage`. +When you write a webapplication with Maven, your `pom.xml` file defines how the +application should be packaged. The Maven build is then typically what you need +for production. During local development, the Frank!Runner helps you to deploy +your application in Tomcat. The Frank!Runner then configures the following in +Tomcat, allowing you to omit it from your `pom.xml`: + +* The Frank!Runner adds a database driver for the h2 database in Tomcat's `lib` +folder. The Frank!Runner also adds a `context.xml` to allow access to a h2 +database. +* The Frank!Runner adds `geronimo-jms_1.1_spec.jar` to Tomcat's `lib` folder. +This file should not be packaged in your WAR because it should be provided by +application servers according to the Jakarta EE standard. Tomcat does not +provide this file however and hence this library has to be added. +* The Frank!Runner configures `catalina.properties` to define a scenarios root +directory for Larva. The Frank!Runner configures the absolute path to +`src/test/testtool`. +* The Frank!Runner configures in `cataline.properties` that `dtap.stage=LOC`. +This way, you can access your webapp through http during development. If you do +not set `dtap.stage` in your packaged application, it is up to the system +administrator of the user to configure `dtap.stage`. # Root CA certificates