Restructure into use cases and technology (repo unfrozen if merged) (TimefoldAI#129)

Co-authored-by: Radovan Synek <[email protected]>

Author: ge0ffrey

.github/workflows/gradle.yml

@@ -20,7 +20,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix: {
-        quickstartDir: ['hello-world-school-timetabling', 'quarkus-school-timetabling', 'spring-boot-school-timetabling']
+        quickstartDir: ['hello-world', 'use-cases/school-timetabling', 'technology/java-spring-boot']
       }
     steps:
       - uses: actions/checkout@v2

README.adoc

@@ -1,12 +1,35 @@
 = OptaPlanner Quickstarts
 
+== Overview of all Quickstarts
+
+[cols="1,1"]
+|===
+|*Use case quickstarts*
+|*Technology quickstarts*
+
+a|* <<school-timetabling, School timetabling>>
+* <<facility-location, Facility location problem>>
+* <<maintenance-scheduling, Maintenance scheduling>>
+* <<call-center, Call center>>
+* <<vaccination-scheduling, Vaccination Scheduling>>
+
+a|* link:use-cases/school-timetabling/README.adoc[Quarkus] (Java, Maven or Gradle, Quarkus, H2)
+* link:technology/java-spring-boot/README.adoc[Spring Boot] (Java, Maven or Gradle, Spring Boot, H2)
+* link:technology/java-activemq-quarkus/README.adoc[ActiveMQ] (Java, ActiveMQ, Maven, Quarkus)
+* link:technology/kotlin-quarkus/README.adoc[Kotlin] (Kotlin, Maven, Quarkus, H2)
+
+2+a|* <<optaweb-vehicle-routing, OptaWeb Vehicle Routing>>
+* <<optaweb-employee-rostering, OptaWeb Employee Rostering>>
+* <<optaplanner-examples, OptaPlanner examples (desktop)>>
+|===
+
 == Get started
 
 Run the https://www.optaplanner.org/[OptaPlanner] quickstarts now:
 
 . https://adoptopenjdk.net[Install JDK 11 or later] with `JAVA_HOME` configured appropriately.
 
-. Clone this repository to build and run the quickstarts:
+. Clone this repository to build and run the quickstarts showcase:
 +
 [source, shell]
 ----
@@ -17,25 +40,21 @@ $ ./runQuickstartsFromSource.sh
 
 == Use cases
 
-* <<school-timetabling, School timetabling>>
-* <<facility-location, Facility location problem>>
-* <<maintenance-scheduling, Maintenance scheduling>>
-* <<vaccination-scheduling, Vaccination Scheduling>>
-* <<optaweb-vehicle-routing, OptaWeb Vehicle Routing>>
-* <<optaweb-employee-rostering, OptaWeb Employee Rostering>>
-* <<optaplanner-examples, OptaPlanner examples (desktop)>>
-
 [[school-timetabling]]
 === School timetabling
 
 Assign lessons to timeslots and rooms to produce a better schedule for teachers and students.
 
 image::build/quickstarts-showcase/src/main/resources/META-INF/resources/screenshot/quarkus-school-timetabling-screenshot.png[]
 
-* link:quarkus-school-timetabling/README.adoc[Run quarkus-school-timetabling] (Java, Maven or Gradle, Quarkus, H2)
-* link:spring-boot-school-timetabling/README.adoc[Run spring-boot-school-timetabling] (Java, Maven or Gradle, Spring Boot, H2)
-* link:kotlin-quarkus-school-timetabling/README.adoc[Run kotlin-quarkus-school-timetabling] (Kotlin, Maven, Quarkus, H2)
-* link:activemq-quarkus-school-timetabling/README.adoc[Run activemq-quarkus-school-timetabling] (ActiveMQ, Maven, Quarkus)
+* link:use-cases/school-timetabling/README.adoc[Run quarkus-school-timetabling] (Java, Maven or Gradle, Quarkus, H2)
+* link:technology/java-spring-boot/README.adoc[Run spring-boot-school-timetabling] (Java, Maven or Gradle, Spring Boot, H2)
+* link:technology/java-activemq-quarkus/README.adoc[Run activemq-quarkus-school-timetabling] (Java, ActiveMQ, Maven, Quarkus)
+* link:technology/kotlin-quarkus/README.adoc[Run kotlin-quarkus-school-timetabling] (Kotlin, Maven, Quarkus, H2)
+
+Without a UI:
+
+* link:hello-world/README.adoc[Run hello-world-school-timetabling] (Java, Maven or Gradle)
 
 [[facility-location]]
 === Facility location problem
@@ -44,7 +63,7 @@ Pick the best geographical locations for new stores, distribution centers, covid
 
 image::build/quickstarts-showcase/src/main/resources/META-INF/resources/screenshot/quarkus-facility-location-screenshot.png[]
 
-* link:quarkus-facility-location/README.adoc[Run quarkus-facility-location] (Java, Maven, Quarkus)
+* link:use-cases/facility-location/README.adoc[Run quarkus-facility-location] (Java, Maven, Quarkus)
 
 [[maintenance-scheduling]]
 === Maintenance scheduling
@@ -54,7 +73,16 @@ to reduce both premature and overdue maintenance.
 
 image::build/quickstarts-showcase/src/main/resources/META-INF/resources/screenshot/quarkus-maintenance-scheduling-screenshot.png[]
 
-* link:quarkus-maintenance-scheduling/README.adoc[Run quarkus-maintenance-scheduling] (Java, Maven, Quarkus)
+* link:use-cases/maintenance-scheduling/README.adoc[Run quarkus-maintenance-scheduling] (Java, Maven, Quarkus)
+
+[[call-center]]
+=== Call center
+
+Schedule incoming calls to employees matching skills and availability.
+
+image::build/quickstarts-showcase/src/main/resources/META-INF/resources/screenshot/quarkus-call-center-screenshot.png[]
+
+* link:use-cases/call-center/README.adoc[Run quarkus-call-center] (Java, Maven, Quarkus)
 
 [[vaccination-scheduling]]
 === Vaccination scheduling
@@ -64,7 +92,7 @@ to end a pandemic sooner.
 
 image::build/quickstarts-showcase/src/main/resources/META-INF/resources/screenshot/quarkus-vaccination-scheduling-screenshot.png[]
 
-* link:quarkus-vaccination-scheduling/README.adoc[Run quarkus-vaccination-scheduling] (Java, Maven, Quarkus)
+* link:use-cases/vaccination-scheduling/README.adoc[Run quarkus-vaccination-scheduling] (Java, Maven, Quarkus)
 
 [[optaweb-vehicle-routing]]
 === OptaWeb Vehicle Routing

.mvn/wrapper/MavenWrapperDownloader.java build/.mvn/wrapper/MavenWrapperDownloader.java

@@ -49,58 +49,36 @@
       </includes>
     </fileSet>
     <fileSet>
-      <directory>../../quarkus-school-timetabling/target</directory>
-      <outputDirectory>binaries/quarkus-school-timetabling</outputDirectory>
+      <directory>../../use-cases/school-timetabling/target</directory>
+      <outputDirectory>binaries/use-cases/school-timetabling</outputDirectory>
       <includes>
         <include>quarkus-app/**</include>
       </includes>
     </fileSet>
     <fileSet>
-      <directory>../../quarkus-facility-location/target</directory>
-      <outputDirectory>binaries/quarkus-facility-location</outputDirectory>
+      <directory>../../use-cases/facility-location/target</directory>
+      <outputDirectory>binaries/use-cases/facility-location</outputDirectory>
       <includes>
         <include>quarkus-app/**</include>
       </includes>
     </fileSet>
     <fileSet>
-      <directory>../../quarkus-maintenance-scheduling/target</directory>
-      <outputDirectory>binaries/quarkus-maintenance-scheduling</outputDirectory>
+      <directory>../../use-cases/maintenance-scheduling/target</directory>
+      <outputDirectory>binaries/use-cases/maintenance-scheduling</outputDirectory>
       <includes>
         <include>quarkus-app/**</include>
       </includes>
     </fileSet>
     <fileSet>
-      <directory>../../quarkus-vaccination-scheduling/target</directory>
-      <outputDirectory>binaries/quarkus-vaccination-scheduling</outputDirectory>
+      <directory>../../use-cases/vaccination-scheduling/target</directory>
+      <outputDirectory>binaries/use-cases/vaccination-scheduling</outputDirectory>
       <includes>
         <include>quarkus-app/**</include>
       </includes>
     </fileSet>
     <fileSet>
-      <directory>../../quarkus-call-center/target</directory>
-      <outputDirectory>binaries/quarkus-call-center</outputDirectory>
-      <includes>
-        <include>quarkus-app/**</include>
-      </includes>
-    </fileSet>
-    <fileSet>
-      <directory>../../activemq-quarkus-school-timetabling</directory>
-      <outputDirectory>binaries/activemq-quarkus-school-timetabling</outputDirectory>
-      <includes>
-        <include>broker-*.xml</include>
-        <include>docker-compose.yml</include>
-      </includes>
-    </fileSet>
-    <fileSet>
-      <directory>../../activemq-quarkus-school-timetabling/activemq-quarkus-school-timetabling-client/target</directory>
-      <outputDirectory>binaries/activemq-quarkus-school-timetabling/activemq-quarkus-school-timetabling-client</outputDirectory>
-      <includes>
-        <include>quarkus-app/**</include>
-      </includes>
-    </fileSet>
-    <fileSet>
-      <directory>../../activemq-quarkus-school-timetabling/activemq-quarkus-school-timetabling-solver/target</directory>
-      <outputDirectory>binaries/activemq-quarkus-school-timetabling/activemq-quarkus-school-timetabling-solver</outputDirectory>
+      <directory>../../use-cases/call-center/target</directory>
+      <outputDirectory>binaries/use-cases/call-center</outputDirectory>
       <includes>
         <include>quarkus-app/**</include>
       </includes>

.mvn/wrapper/maven-wrapper.jar build/.mvn/wrapper/maven-wrapper.jar

@@ -6,8 +6,8 @@
   <fileSets>
     <fileSet>
       <useDefaultExcludes>false</useDefaultExcludes>
-      <directory>../../hello-world-school-timetabling</directory>
-      <outputDirectory>sources/hello-world-school-timetabling</outputDirectory>
+      <directory>../../hello-world</directory>
+      <outputDirectory>sources/hello-world</outputDirectory>
       <excludes>
         <exclude>target/**</exclude>
         <exclude>build/**</exclude>
@@ -17,8 +17,8 @@
     </fileSet>
     <fileSet>
       <useDefaultExcludes>false</useDefaultExcludes>
-      <directory>../../quarkus-school-timetabling</directory>
-      <outputDirectory>sources/quarkus-school-timetabling</outputDirectory>
+      <directory>../../use-cases/school-timetabling</directory>
+      <outputDirectory>sources/use-cases/school-timetabling</outputDirectory>
       <excludes>
         <exclude>target/**</exclude>
         <exclude>build/**</exclude>
@@ -28,44 +28,49 @@
     </fileSet>
     <fileSet>
       <useDefaultExcludes>false</useDefaultExcludes>
-      <directory>../../quarkus-maintenance-scheduling</directory>
-      <outputDirectory>sources/quarkus-maintenance-scheduling</outputDirectory>
+      <directory>../../use-cases/facility-location</directory>
+      <outputDirectory>sources/use-cases/facility-location</outputDirectory>
       <excludes>
         <exclude>target/**</exclude>
         <exclude>.gitignore</exclude>
       </excludes>
     </fileSet>
     <fileSet>
       <useDefaultExcludes>false</useDefaultExcludes>
-      <directory>../../quarkus-facility-location</directory>
-      <outputDirectory>sources/quarkus-facility-location</outputDirectory>
+      <directory>../../use-cases/maintenance-scheduling</directory>
+      <outputDirectory>sources/use-cases/maintenance-scheduling</outputDirectory>
       <excludes>
         <exclude>target/**</exclude>
         <exclude>.gitignore</exclude>
       </excludes>
     </fileSet>
     <fileSet>
       <useDefaultExcludes>false</useDefaultExcludes>
-      <directory>../../quarkus-vaccination-scheduling</directory>
-      <outputDirectory>sources/quarkus-vaccination-scheduling</outputDirectory>
+      <directory>../../use-cases/call-center</directory>
+      <outputDirectory>sources/use-cases/call-center</outputDirectory>
       <excludes>
         <exclude>target/**</exclude>
         <exclude>.gitignore</exclude>
       </excludes>
     </fileSet>
     <fileSet>
       <useDefaultExcludes>false</useDefaultExcludes>
-      <directory>../../quarkus-call-center</directory>
-      <outputDirectory>sources/quarkus-call-center</outputDirectory>
+      <directory>../../use-cases/vaccination-scheduling</directory>
+      <outputDirectory>sources/use-cases/vaccination-scheduling</outputDirectory>
       <excludes>
         <exclude>target/**</exclude>
         <exclude>.gitignore</exclude>
       </excludes>
     </fileSet>
     <fileSet>
       <useDefaultExcludes>false</useDefaultExcludes>
-      <directory>../../spring-boot-school-timetabling</directory>
-      <outputDirectory>sources/spring-boot-school-timetabling</outputDirectory>
+      <directory>../../technology/java-quarkus</directory>
+      <outputDirectory>sources/technology/java-quarkus</outputDirectory>
+    </fileSet>
+    <fileSet>
+      <useDefaultExcludes>false</useDefaultExcludes>
+      <directory>../../technology/java-spring-boot</directory>
+      <outputDirectory>sources/technology/java-spring-boot</outputDirectory>
       <excludes>
         <exclude>target/**</exclude>
         <exclude>build/**</exclude>
@@ -75,20 +80,20 @@
     </fileSet>
     <fileSet>
       <useDefaultExcludes>false</useDefaultExcludes>
-      <directory>../../kotlin-quarkus-school-timetabling</directory>
-      <outputDirectory>sources/kotlin-quarkus-school-timetabling</outputDirectory>
+      <directory>../../technology/java-activemq-quarkus</directory>
+      <outputDirectory>sources/technology/java-activemq-quarkus</outputDirectory>
       <excludes>
-        <exclude>target/**</exclude>
-        <exclude>.gitignore</exclude>
+        <exclude>**/target/**</exclude>
+        <exclude>**/.gitignore</exclude>
       </excludes>
     </fileSet>
     <fileSet>
       <useDefaultExcludes>false</useDefaultExcludes>
-      <directory>../../activemq-quarkus-school-timetabling</directory>
-      <outputDirectory>sources/activemq-quarkus-school-timetabling</outputDirectory>
+      <directory>../../technology/kotlin-quarkus</directory>
+      <outputDirectory>sources/technology/kotlin-quarkus</outputDirectory>
       <excludes>
-        <exclude>**/target/**</exclude>
-        <exclude>**/.gitignore</exclude>
+        <exclude>target/**</exclude>
+        <exclude>.gitignore</exclude>
       </excludes>
     </fileSet>
   </fileSets>

.mvn/wrapper/maven-wrapper.properties build/.mvn/wrapper/maven-wrapper.properties

@@ -68,11 +68,11 @@ public class QuickstartLauncherResource {
 
     public void setup(@Observes StartupEvent startupEvent) {
         quickstartMetaList = Arrays.asList(
-                new QuickstartMeta("quarkus-school-timetabling"),
-                new QuickstartMeta("quarkus-facility-location"),
-                new QuickstartMeta("quarkus-maintenance-scheduling"),
-                new QuickstartMeta("quarkus-vaccination-scheduling"),
-                new QuickstartMeta("quarkus-call-center"));
+                new QuickstartMeta("school-timetabling"),
+                new QuickstartMeta("facility-location"),
+                new QuickstartMeta("maintenance-scheduling"),
+                new QuickstartMeta("vaccination-scheduling"),
+                new QuickstartMeta("call-center"));
         File workingDirectory;
         try {
             workingDirectory = new File(".").getCanonicalFile();
@@ -133,7 +133,7 @@ public void launchQuickstart(@PathParam("quickstartId") String quickstartId) {
             processBuilder = new ProcessBuilder("java", portArg, corsArg, "-jar",
                     getQuickstartRunnerJar(quickstartId).getAbsolutePath());
         }
-        processBuilder.directory(new File(baseDirectory, quickstartId));
+        processBuilder.directory(new File(new File(baseDirectory, "use-cases"), quickstartId));
         processBuilder.inheritIO();
         Process process;
         try {
@@ -149,7 +149,8 @@ public void launchQuickstart(@PathParam("quickstartId") String quickstartId) {
     }
 
     private File getQuickstartRunnerJar(String quickstartId) {
-        File quickstartRunnerJar = FileSystems.getDefault().getPath(baseDirectory.getAbsolutePath(), quickstartId,
+        File quickstartRunnerJar = FileSystems.getDefault().getPath(baseDirectory.getAbsolutePath(),
+                "use-cases", quickstartId,
                 "quarkus-app", "quarkus-run.jar").toFile();
         if (!quickstartRunnerJar.exists()) {
             throw new IllegalStateException(
@@ -167,7 +168,7 @@ private String findMvnCommand(File baseDirectory) {
         if (!maybeMavenHome.isPresent()) {
             LOGGER.warn("Cannot find Maven home. Falling back to Maven Wrapper."
                     + " Maybe define environment variable M3_HOME instead.");
-            String scriptFileName = System.getProperty("os.name").startsWith("Windows") ? "mvnw.cmd" : "mvnw";
+            String scriptFileName = System.getProperty("os.name").startsWith("Windows") ? "build/mvnw.cmd" : "build/mvnw";
             return new File(baseDirectory, scriptFileName).getAbsolutePath();
         }
         String mavenHome = maybeMavenHome.get().replaceFirst("^~", System.getProperty("user.home"));

mvnw build/mvnw

@@ -143,20 +143,20 @@ $(document).ready(function () {
       });
     };
   });
-  $("#quarkus-school-timetabling-launch").click(function () {
-    launchQuickstart("quarkus-school-timetabling");
+  $("#school-timetabling-launch").click(function () {
+    launchQuickstart("school-timetabling");
   });
-  $("#quarkus-facility-location-launch").click(function () {
-    launchQuickstart("quarkus-facility-location");
+  $("#facility-location-launch").click(function () {
+    launchQuickstart("facility-location");
   });
-  $("#quarkus-maintenance-scheduling-launch").click(function () {
-    launchQuickstart("quarkus-maintenance-scheduling");
+  $("#maintenance-scheduling-launch").click(function () {
+    launchQuickstart("maintenance-scheduling");
   });
-  $("#quarkus-vaccination-scheduling-launch").click(function () {
-    launchQuickstart("quarkus-vaccination-scheduling");
+  $("#call-center-launch").click(function () {
+      launchQuickstart("call-center");
   });
-  $("#quarkus-call-center-launch").click(function () {
-      launchQuickstart("quarkus-call-center");
+  $("#vaccination-scheduling-launch").click(function () {
+    launchQuickstart("vaccination-scheduling");
   });
   $("#exit").click(function () {
     exit();